Customer Onboarding using Existing KYC
Verify Customer KYC using a Partner's existing KYC infrastructure and create a new customer account if one does not exist. The Coinme compliance team will review the use of the Partner's existing KYC program, which is subject to approval.
For staging, the Customer Onboarding URL is https://secure.apis.coinme.org/services/customeronboarding
For production, is https://secure.apis.coinme.com/services/customeronboarding
Assumptions:
- The Partner should perform 2FA and ensure it is passed. They should not send onboarding requests if 2FA is not passed.
Sample API Request: POST
URL: https://secure.apis.coinme.org/services/customeronboarding
headers:
"Authorization":"asdfghj", //authorization token,required
'User-Agent: partnerapi' //required
Request body:
{
"email": "[email protected]", // required
"fullName": {
"firstName": "TestFirst", // required
"middleName": "TestMiddle",
"lastName": "TestLast", // required
"otherNames": [
"secondLastName",
"otherName1",
"otherName2"
]
},
"address": {
"line1": "1234 Example St", // required
"line2": "Apt 4",
"city": "Foo City", // required
"state": "CA", // required
"postalCode": "93420", // required
"country": "USA" // required, 3-character abbreviation
},
"phoneNumber": {
"countryCode": "1", // required
"number": "8001234567" // required
},
"dateOfBirth": "1965-02-10", // required
"SSN": "123-123-1234" // required
}
Sample API Response:
Successful Response:
{
"data":
{
"customerId": "654987321"
},
"errorResponse": null
}
Failure Response:
{
"data": null,
"errorResponse": {
"httpStatus":"200",
"timestamp":"2022-02-01T18:59:28.297Z",//UTC
"path":"/services/customeronboarding POST",
"errorData": [
{
"errorCode":"123-123-123-123",//The error code is just a sample showing the structure of the error code.
"message":"Customer identity could not be validated"
}
],
"retry":"N"
}
}
Error Codes
| Error Code | Error Message | Retriable? |
|---|---|---|
| 206-400-100-001 | Unique customer identifiers match an account that already exists for this partner | N |
| 206-400-100-011 | Customer does not meet the age requirements | N |
| 206-400-100-012 | Customer does not reside in a valid jurisdiction | N |
| 206-400-100-014 | Customer has one or more identifiers on a Coinme prohibited list | N |
| 206-400-100-020 | Customer has failed our identity verification check and may be passing incorrect data | Y |
| 206-400-100-031 | Customer has 100% name match with a sanctioned individual | N |
| 206-400-100-032 | Customer has matching hits on DOB with a sanctioned individual(s) | N |
| 206-400-100-033 | Customer has matching hits on both DOB and country with a sanctioned individual(s) | N |
| 206-400-100-034 | Customer has a person-name match score above 70%, but the sanctioned individual does not have a birthdate | N |
| 206-400-100-035 | Customer has a person-name match score above 70% and a country match, but the sanctioned individual does not have a birthdate | N |
| 206-400-100-036 | Customer's social security number or taxpayer identification number has a sanctions match | N |
| 206-500-100-999 | Unexpected internal error | Y |
| 206-400-100-999 | Invalid request parameters | Y |
Updated 6 days ago
What’s Next