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 CodeError MessageRetriable?
206-400-100-001Unique customer identifiers match an account that already exists for this partnerN
206-400-100-011Customer does not meet the age requirementsN
206-400-100-012Customer does not reside in a valid jurisdictionN
206-400-100-014Customer has one or more identifiers on a Coinme prohibited listN
206-400-100-020Customer has failed our identity verification check and may be passing incorrect dataY
206-400-100-031Customer has 100% name match with a sanctioned individualN
206-400-100-032Customer has matching hits on DOB with a sanctioned individual(s)N
206-400-100-033Customer has matching hits on both DOB and country with a sanctioned individual(s)N
206-400-100-034Customer has a person-name match score above 70%, but the sanctioned individual does not have a birthdateN
206-400-100-035Customer has a person-name match score above 70% and a country match, but the sanctioned individual does not have a birthdateN
206-400-100-036Customer's social security number or taxpayer identification number has a sanctions matchN
206-500-100-999Unexpected internal errorY
206-400-100-999Invalid request parametersY

What’s Next