Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nestcoin users-onboardapi API

Endpoints available to for merchants liquidity automation

Nestcoin users-onboardapi API is one of 23 APIs that Nestcoin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include users-onboardapi. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 10 schemas. It is described by OpenAPI 3.0.3, at version 3.0.2.

Requests are made against a single base URL, https://external.dev.onboardpay.co.

1 operations 1 paths 10 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.2
Base URL
https://external.dev.onboardpay.co
Authentication
API Key, API Key
License
UNLICENSED
Resource Areas
1

Authentication & Security 2

Nestcoin users-onboardapi API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-signature (authSignature). An API key is passed in the header as x-auth-token (authToken).

  • authToken — Auth Token header for inter-service communication

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

users-onboardapi 1

Endpoints available to for merchants liquidity automation

GET
/users/me
Get a single user by their authorization token
getMyProfile → 200400401404500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are UserDataDto (35 properties), ProfileDataDto (18 properties), KycNameChangeHistoryDto (6 properties), UserTransactionLimit (4 properties). Each schema is shown below with its type and property counts.

UserTransactionLimit
object
4 properties
ProfileDataDto
object
18 properties
ErrorMessageDto
object
Default error object for services. This gives consistent error object that all services may use.
3 properties 2 required
KycNameChangeHistoryDto
object
6 properties 5 required
VerificationStatus
string
user's verification status
KycJobStatus
string
ProfileTradeDto
object
3 properties
UsersSvcUserType
string
the type of the user
UserRoles
string
the roles a user can possess on Onboard
UserDataDto
object
35 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nestcoin-users-onboardapi-api-openapi.yml Raw ↑

Other APIs Nestcoin publishes across the network.

Nestcoin auth-oauth API
Nestcoin auth-userauth API
Nestcoin exchange-external-api API
Nestcoin exchange-orders API
Nestcoin ledger-account activity API
Nestcoin ledger-accounts API
Nestcoin ledger-beneficiaries API
Nestcoin ledger-cash deposits API
Nestcoin ledger-offramp accounts API
Nestcoin ledger-payments API
Nestcoin ledger-sub-accounts API
Nestcoin ledger-transfer API