This section outlines all the needed information and endpoints that are required to perform the available actions.
Common Headers
The table below shows all of the common API Headers you will encounter in the Coins Access API.
| Header Name | Required | Type | Example | Description |
|---|---|---|---|---|
X-Merchant-Key | yes | string | The authorized merchant key | |
X-Merchant-Sign | yes | string | The authorized merchant request sign | |
X-Timestamp | yes | long | 1671158910 | |
X-Trace-Id | no | string | Request log trace ID |
To craft an X-Merchant-Sign:
- Construct a message according to the following pseudo-grammar:
‘X-Timestamp’ + URL + BODY - Calculate an HMAC with the message string you just created, your API secret as the key, and SHA256 as the hash algorithm.
User Related Endpoints
The diagram below delineates the user registration and KYC review process:
Sharing User’s KYC Information with Coins Access and Registering the User
When opening an account with the Merchant, the user submits the required KYC information. This endpoint is used to share the user’s KYC information with Coins Access and register them at Coins Access.
| Parameter Name | Layout | Required | Description |
|---|---|---|---|
| userId | Request Body | yes | User ID in the Merchant’s platform |
| Request Body | no | Email address | |
| phone | Request Body | yes | Mobile number. At least one email or phone must be provided. |
| verified | Request Body | no | Indicates whether the user was verified by Merchant |
| verifiedTime | Request Body | no | If the user was verified by Merchant, this parameter indicates the verification time |
| needRecheck | Request Body | no | Indicates whether Coins must recheck the user’s KYC |
| kycType | Request Body | yes | KYC or KYB user |
| kycInfo | Request Body | yes | The user’s information that Merchant shares with Coins. See an example below. |