Prime Trust KYC Process

There are multiple times when an entity needs to clear Prime Trust's "Know Your Customer" (KYC) process including account opening or if a contact is added to an account for KYC purposes. Personal identifying information (PII) of end-users in the PT system are represented as contacts.

Steps to Clear Prime Trust's KYC Process

To clear Prime Trust's KYC process, a contact must usually go through three different checks. These checks are listed below:

  1. Cip check is the check where PT checks the person or company is who they say they are. They are created immediately after a contact is created
  2. Kyc document checks can be created on documents uploaded to a contact, clearing a document check will also generally clear cip. It is part of the CIP process and may be required as set by the account policies.
  3. Aml check is the check where PT checks to ensure the person or company are not on any sanctions lists.

Individual KYC Process

PTs compliance team requires the following information to clear the KYC process for an individual:

  1. Full Name
  2. Date of Birth
  3. Tax ID Number for US or ID # listed on uploaded proof id for Non US
  4. Tax country (country of proof of ID)
  5. Tax State (tax state for US persons only)
  6. Address (Street address, City, State/Region, Country, Postal Code) (Address provided must match ID or Proof of Address)
  7. Optional - IP address (IPv4 decimal or IPv6 hexadecimal format)
  8. Optional - Geolocation (ISO 6709 format)

Documents required from an individual:

  1. Valid Proof of Govt Issued ID
  2. Proof of Address valid within the last 90 days only if the address is not listed on the govt issued ID.

The process to clear an individual through PTs KYC process will look as follows:

  1. Create a contact with the persons PII either directly or on account opening as needed by your use-case.
  2. Upload id and proof of address documents to the contact created in the earlier step.
  3. Create a kyc document check

Note that all documents and information should be in Latin chracters or should have translated versions of documents as well.

Request

POST v2/contacts
{
"data" : {
"type" : "contacts",
"attributes": {
"account-id" : "{{account-id}}",
"contact-type" : "natural_person",
"name" : "John James Doe",
"email" : "johndoe@email.in",
"date-of-birth" : "1980-06-09",
"ip-address" : "{{optional, IPv4 decimal or IPv6 hexadecimal format}}",
"geolocation" : "{{optional, ISO 6709 format}}",
"sex" : "male",
"tax-id-number" : "123123123",
"tax-country" : "US",
"primary-phone-number" : {
"country" : "US",
"number" : "1231231231",
"sms" : true
},
"primary-address" : {
"street-1" : "123 MK Road",
"street-2" : "Flat 3",
"postal-code" : "89145",
"city" : "Las Vegas",
"region" : "NV",
"country" : "US"
}
}
}
}

Response

{
"data": {
"type": "contacts",
"id": "7ae9525b-4127-48e8-a089-80199b0383cd",
"attributes": {
"account-roles": [],
"aml-cleared": false,
"cip-cleared": false,
"contact-type": "natural_person",
"date-of-birth": "1980-06-09",
"email": "johndoe@email.in",
"geolocation" : "{{optional}}",
"identity-confirmed": false,
"identity-documents-verified": false,
"ip-address" : "{{optional}}"
"name": "John James Doe",
"proof-of-address-documents-verified": false,
"region-of-formation": null,
"sex": "male",
"tax-country": "US",
"tax-id-number": "123123123",
"tax-state": "NV",
"type": "natural-person",
"created-at": "2019-12-03T17:21:04Z",
"updated-at": "2019-12-03T17:21:04Z"
},
"links": {
"self": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd"
},
"relationships": {
"addresses": {
"links": {
"related": "/v2/addresses?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"aml-checks": {
"links": {
"related": "/v2/aml-checks?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"asset-transfers": {
"links": {
"related": "/v2/asset-transfers?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"asset-transfer-methods": {
"links": {
"related": "/v2/asset-transfer-methods?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"cip-checks": {
"links": {
"related": "/v2/cip-checks?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"contact-funds-transfer-references": {
"links": {
"related": "/v2/contact-funds-transfer-references?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"contributions": {
"links": {
"related": "/v2/contributions?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"disbursements": {
"links": {
"related": "/v2/disbursements?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"from-contact-relationships": {
"links": {
"related": "/v2/contact-relationships?from-contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"funds-transfer-methods": {
"links": {
"related": "/v2/funds-transfer-methods?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"funds-transfers": {
"links": {
"related": "/v2/funds-transfers?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"kyc-document-checks": {
"links": {
"related": "/v2/kyc-document-checks?contacts.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"payment-methods": {
"links": {
"related": "/v2/payment-methods?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"phone-numbers": {
"links": {
"related": "/v2/phone-numbers?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"related-from-contacts": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd/related-from-contacts"
}
},
"related-to-contacts": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd/related-to-contacts"
}
},
"to-contact-relationships": {
"links": {
"related": "/v2/contact-relationships?to-contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"uploaded-documents": {
"links": {
"related": "/v2/uploaded-documents?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"primary-address": {
"links": {
"related": "/v2/addresses/a7267de0-d19f-45d6-ade6-50b92ef611d1"
}
},
"primary-contact": {
"data": null
},
"primary-phone-number": {
"links": {
"related": "/v2/phone-numbers/bf2a7757-b5ab-4494-ad1e-b42bc2a44d2f"
}
},
"latest-cip-check": {
"links": {
"related": "/v2/cip-checks?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd&sort=-created-at&limit=1"
}
},
"latest-aml-check": {
"links": {
"related": "/v2/aml-checks?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd&sort=-created-at&limit=1"
}
},
"latest-kyc-document-check": {
"links": {
"related": "/v2/kyc-document-checks?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd&sort=-created-at&limit=1"
}
}
}
},
"included": []
}

Request

POST v2/uploaded-documents

Example in CURL

curl -X POST https://sandbox.primetrust.com/v2/uploaded-documents \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGfpOiJIUzI1NiJ9.eyJhdXRoX2lkIjoiZTUwODliNjItNzMwOC00ZDY3LThiNjAtMTAxZjZmNGU3MDc5IiwiZXhwIjoxNTQzNzEyMjkzfQ.T8pH1wPwfgj4lPXWroEAk0rLuE7_i2y53BBGEMY7sNA' \
-F 'contact-id=2be84953-3fd7-4442-8497-c3056b089a5e' \
-F 'label=drivers_license' \
-F 'public=false' \
-F 'file=@washington_sample_license.jpg'

Unlike other endpoints the POST request does not conform with JSONAPI and instead uses a multipart form request. Only one file can be uploaded per request. And hence a Header with Content-Type: multipart/form-data must be set.

Response

{
"data": {
"type": "uploaded-documents",
"id": "8c9e8156-e787-4490-bbd8-995fd7342098",
"attributes": {
"allow-download": true,
"created-at": "2019-12-03T17:28:59Z",
"description": null,
"extension": ".png",
"file-url": "https://s3.amazonaws.com/uploads.sandbox.primetrust.com/uploaded_documents/8c9e8156-e787-4490-bbd8-995fd7342098.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA3IAMB4HICHKIYMFE%2F20191203%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20191203T172859Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=e2f96250226641dcbada813f77a9880c8352ca58e10555c8db102fa34f5fba9e",
"label": "\"Drivers License\"",
"mime-type": "image/png",
"public": false,
"version-urls": {
"original": "https://s3.amazonaws.com/uploads.sandbox.primetrust.com/uploaded_documents/8c9e8156-e787-4490-bbd8-995fd7342098.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA3IAMB4HICHKIYMFE%2F20191203%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20191203T172859Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=e2f96250226641dcbada813f77a9880c8352ca58e10555c8db102fa34f5fba9e"
}
},
"links": {
"self": "/v2/uploaded-documents/8c9e8156-e787-4490-bbd8-995fd7342098"
},
"relationships": {
"accounts": {
"links": {
"related": "/v2/accounts?uploaded-documents.id=8c9e8156-e787-4490-bbd8-995fd7342098"
}
},
"contact": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"bank-report": {
"links": {
"related": "/v2/bank-reports?uploaded_documents.id=8c9e8156-e787-4490-bbd8-995fd7342098"
}
},
"kyc-document-check": {
"links": {
"related": "/v2/kyc-document-checks?uploaded-documents.id=8c9e8156-e787-4490-bbd8-995fd7342098"
}
},
"kyc-backside-document-check": {
"links": {
"related": "/v2/kyc-document-checks?uploaded-documents.id=8c9e8156-e787-4490-bbd8-995fd7342098"
}
}
}
},
"included": []
}

Request

POST v2/kyc-document-checks
{
"data" : {
"type" : "kyc-document-checks",
"attributes" : {
"contact-id" : "{{contact-id}}",
"uploaded-document-id" : "{{uploaded-document-id}}",
"backside-document-id" : "{{uploaded-document-backside-id}}",
"expires-on" : "2029-12-30",
"identity" : true,
"identity-photo" : true,
"proof-of-address" : true,
"kyc-document-country" : "US",
"kyc-document-type" : "drivers_license"
}
}
}

Response

{
"data": {
"type": "kyc-document-checks",
"id": "47a0f860-39a6-47ed-bec0-f28a6cc9eb1f",
"attributes": {
"created-at": "2019-12-03T17:37:49Z",
"expires-on": "2029-12-30",
"exceptions": [
"auto_check_failed"
],
"failure-details": null,
"identity": true,
"identity-photo": true,
"kyc-document-country": "US",
"kyc-document-other-type": null,
"kyc-document-type": "drivers_license",
"proof-of-address": true,
"status": "pending",
"updated-at": "2019-12-03T17:37:49Z"
},
"links": {
"self": "/v2/kyc-document-checks/47a0f860-39a6-47ed-bec0-f28a6cc9eb1f"
},
"relationships": {
"contact": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"uploaded-document": {
"links": {
"related": "/v2/uploaded-documents/8c9e8156-e787-4490-bbd8-995fd7342098"
}
},
"backside-document": {
"links": {
"related": "/v2/uploaded-documents/4d373402-1192-42d9-93f3-54a9c8851205"
}
}
}
},
"included": []
}

Tracking the KYC Process

The checks can be monitored for exceptions or failures to see if information needs to be updated on the contact and/or if new documents need to be uploaded to clear CIP, kyc-document-checks or aml-checks along with the statuses on the contact itself. These should be monitored via webhooks but can be checked for further detail as seen below.

Request

GET v2/contacts?filter[contact.id eq]={{contact-id}}&include=cip-checks,aml-checks,kyc-document-checks

Response

{
"links": {
"self": "/v2/contacts?filter%5Bid+eq%5D=7ae9525b-4127-48e8-a089-80199b0383cd&include=cip-checks%2Caml-checks%2Ckyc-document-checks",
"first": "/v2/contacts?filter%5Bid+eq%5D=7ae9525b-4127-48e8-a089-80199b0383cd&include=cip-checks%2Caml-checks%2Ckyc-document-checks&page%5Bnumber%5D=1&page%5Bsize%5D=25"
},
"meta": {
"page-count": 1,
"resource-count": 1
},
"data": [
{
"type": "contacts",
"id": "7ae9525b-4127-48e8-a089-80199b0383cd",
"attributes": {
"account-roles": [],
"aml-cleared": false,
"cip-cleared": false,
"contact-type": "natural_person",
"date-of-birth": "1980-06-09",
"email": "johndoe@email.in",
"identity-confirmed": false,
"identity-documents-verified": false,
"name": "John James Doe",
"proof-of-address-documents-verified": false,
"region-of-formation": null,
"sex": "male",
"tax-country": "US",
"tax-id-number": "123123123",
"tax-state": "NV",
"type": "natural-person",
"created-at": "2019-12-03T17:21:04Z",
"updated-at": "2019-12-03T17:21:04Z"
},
"links": {
"self": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd"
},
"relationships": {
"addresses": {
"links": {
"related": "/v2/addresses?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"aml-checks": {
"data": []
},
"asset-transfers": {
"links": {
"related": "/v2/asset-transfers?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"asset-transfer-methods": {
"links": {
"related": "/v2/asset-transfer-methods?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"cip-checks": {
"data": [
{
"type": "cip-checks",
"id": "782fed91-2fa5-47d6-b33a-a1a76f081e90"
}
]
},
"contact-funds-transfer-references": {
"links": {
"related": "/v2/contact-funds-transfer-references?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"contributions": {
"links": {
"related": "/v2/contributions?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"disbursements": {
"links": {
"related": "/v2/disbursements?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"from-contact-relationships": {
"links": {
"related": "/v2/contact-relationships?from-contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"funds-transfer-methods": {
"links": {
"related": "/v2/funds-transfer-methods?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"funds-transfers": {
"links": {
"related": "/v2/funds-transfers?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"kyc-document-checks": {
"data": [
{
"type": "kyc-document-checks",
"id": "47a0f860-39a6-47ed-bec0-f28a6cc9eb1f"
}
]
},
"payment-methods": {
"links": {
"related": "/v2/payment-methods?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"phone-numbers": {
"links": {
"related": "/v2/phone-numbers?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"related-from-contacts": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd/related-from-contacts"
}
},
"related-to-contacts": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd/related-to-contacts"
}
},
"to-contact-relationships": {
"links": {
"related": "/v2/contact-relationships?to-contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"uploaded-documents": {
"links": {
"related": "/v2/uploaded-documents?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"primary-address": {
"links": {
"related": "/v2/addresses/a7267de0-d19f-45d6-ade6-50b92ef611d1"
}
},
"primary-contact": {
"data": null
},
"primary-phone-number": {
"links": {
"related": "/v2/phone-numbers/bf2a7757-b5ab-4494-ad1e-b42bc2a44d2f"
}
},
"latest-cip-check": {
"links": {
"related": "/v2/cip-checks?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd&sort=-created-at&limit=1"
}
},
"latest-aml-check": {
"links": {
"related": "/v2/aml-checks?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd&sort=-created-at&limit=1"
}
},
"latest-kyc-document-check": {
"links": {
"related": "/v2/kyc-document-checks?contact.id=7ae9525b-4127-48e8-a089-80199b0383cd&sort=-created-at&limit=1"
}
}
}
}
],
"included": [
{
"type": "cip-checks",
"id": "782fed91-2fa5-47d6-b33a-a1a76f081e90",
"attributes": {
"created-at": "2019-12-03T17:21:05Z",
"exceptions": [
"manual_review_required"
],
"exception-details": null,
"status": "pending",
"updated-at": "2019-12-03T17:21:05Z"
},
"links": {
"self": "/v2/cip-checks/782fed91-2fa5-47d6-b33a-a1a76f081e90"
},
"relationships": {
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"contact": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd"
}
}
}
},
{
"type": "kyc-document-checks",
"id": "47a0f860-39a6-47ed-bec0-f28a6cc9eb1f",
"attributes": {
"created-at": "2019-12-03T17:37:49Z",
"expires-on": "2029-12-30",
"exceptions": [
"auto_check_failed"
],
"failure-details": null,
"identity": true,
"identity-photo": true,
"kyc-document-country": "US",
"kyc-document-other-type": null,
"kyc-document-type": "drivers_license",
"proof-of-address": true,
"status": "pending",
"updated-at": "2019-12-03T17:37:49Z"
},
"links": {
"self": "/v2/kyc-document-checks/47a0f860-39a6-47ed-bec0-f28a6cc9eb1f"
},
"relationships": {
"contact": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"uploaded-document": {
"links": {
"related": "/v2/uploaded-documents/8c9e8156-e787-4490-bbd8-995fd7342098"
}
},
"backside-document": {
"links": {
"related": "/v2/uploaded-documents/4d373402-1192-42d9-93f3-54a9c8851205"
}
}
}
}
]
}

Entity KYC Process

Clearing a non-natural person through PT's KYC process requires more information but in terms of process is similar to clearing the KYC process for an individual.

PT's compliance team requires the following information to clear a non-natural person aka a company.

  1. Name
  2. Tax-ID
  3. Tax-Country
  4. Region of Formation (Region/State in which the company was created)
  5. Address
  6. PII Information on all beneficial owners, beneficial entities, authorized persons and associated persons. Request the PT Supplemental Onboarding packet from your sales engineer for more information. Beneficial owners which are natural persons will need to go through the PT KYC process for individuals as listed above and any beneficial entities will need to go through the same KYC process as listed in this section. The original company is required to have at least one associated natural person contact.

Documents Required for a company:

  1. Company documents indicating ownership structure such as bylaws, documents of formation etc.
  2. Proof of address such as a bank statement or utility bill.

The PII information for beneficial owners, beneficial entities, authorized perons and associated persons can all be passed in a flat structure in the related-contacts array as seen below. The original/main company contact will need at least one related-contact that is a natural person but other beneficial entities must be passed in without any further related-contacts. If beneficial entities' beneficial owners need to be passed in as they are also beneficial owners of the original company then they must be passed in as a related-contact of the original/main company.

These related-contacts are related-to the original company. The first natural person contact in this array will be treated as the primary contact and this contact cannot be removed until this designation is moved to another natural person contact. See contact-relationships for more information on how these contacts are related to the original company.

Request

POST v2/contacts?include=related-to-contacts
{
"data" : {
"type" : "contacts",
"attributes" : {
"account-id" : "{{account-id}}",
"contact-type" : "company",
"name" : "Big Blockchain Ltd",
"email" : "support@bb.io",
"tax-id-number" : "123123123",
"tax-country" : "US",
"region-of-formation" : "DW",
"primary-phone-number" : {
"country" : "US",
"number" : "7026912022",
"sms" : false
},
"primary-address" : {
"street-1" : "330 S. Rampart",
"street-2" : "Suite 260",
"postal-code" : "89145",
"city" : "Las Vegas",
"region" : "NV",
"country" : "US"
},
"related-contacts" : [
{
"contact-type" : "natural_person",
"name" : "Jill Johnson",
"email" : "jill@bb.io",
"tax-id-number" : "123123123",
"tax-country" : "US",
"date-of-birth" : "1993-03-16",
"sex" : "female",
"label" : "Beneficial Owner 1 - Primary Contact",
"primary-phone-number" : {
"country" : "US",
"number" : "7026912023",
"sms" : false
},
"primary-address" : {
"street-1" : "330 N. Rampart",
"street-2" : "Apt 270",
"postal-code" : "89145",
"city" : "Las Vegas",
"region" : "NV",
"country" : "US"
}
},
{
"contact-type" : "natural_person",
"name" : "James Johnson",
"email" : "james@bb.io",
"tax-id-number" : "123123123",
"tax-country" : "US",
"date-of-birth" : "1993-03-16",
"sex" : "male",
"label" : "Authorized Person",
"primary-phone-number" : {
"country" : "US",
"number" : "7026912024",
"sms" : false
},
"primary-address" : {
"street-1" : "330 N. Rampart",
"street-2" : "Apt 280",
"postal-code" : "89145",
"city" : "Las Vegas",
"region" : "NV",
"country" : "US"
}
},
{
"contact-type" : "company",
"label" : "Beneficial Owner/Entity 2",
"name" : "Parent Blockchain Company",
"email" : "support@bb.io",
"tax-id-number" : "123123123",
"tax-country" : "US",
"region-of-formation" : "DW",
"primary-phone-number" : {
"country" : "US",
"number" : "7026912022",
"sms" : false
},
"primary-address" : {
"street-1" : "330 S. Rampart",
"street-2" : "Suite 260",
"postal-code" : "89145",
"city" : "Las Vegas",
"region" : "NV",
"country" : "US"
}
}
]
}
}
}

Response

{
"data": {
"type": "contacts",
"id": "0e561e6b-c76f-4df7-ae18-4c9248a7edbc",
"attributes": {
"account-roles": [],
"aml-cleared": false,
"cip-cleared": false,
"contact-type": "company",
"date-of-birth": null,
"email": "support@bb.io",
"identity-confirmed": false,
"identity-documents-verified": false,
"name": "Big Blockchain Ltd",
"proof-of-address-documents-verified": false,
"region-of-formation": "DW",
"sex": null,
"tax-country": "US",
"tax-id-number": "123123123",
"tax-state": "NV",
"type": "company",
"created-at": "2019-12-06T19:43:21Z",
"updated-at": "2019-12-06T19:43:21Z"
},
"links": {
"self": "/v2/contacts/0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
},
"relationships": {
"addresses": {
"links": {
"related": "/v2/addresses?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"aml-checks": {
"links": {
"related": "/v2/aml-checks?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"asset-transfers": {
"links": {
"related": "/v2/asset-transfers?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"asset-transfer-methods": {
"links": {
"related": "/v2/asset-transfer-methods?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"cip-checks": {
"links": {
"related": "/v2/cip-checks?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"contact-funds-transfer-references": {
"links": {
"related": "/v2/contact-funds-transfer-references?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"contributions": {
"links": {
"related": "/v2/contributions?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"disbursements": {
"links": {
"related": "/v2/disbursements?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"from-contact-relationships": {
"links": {
"related": "/v2/contact-relationships?from-contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"funds-transfer-methods": {
"links": {
"related": "/v2/funds-transfer-methods?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"funds-transfers": {
"links": {
"related": "/v2/funds-transfers?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"kyc-document-checks": {
"links": {
"related": "/v2/kyc-document-checks?contacts.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"payment-methods": {
"links": {
"related": "/v2/payment-methods?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"phone-numbers": {
"links": {
"related": "/v2/phone-numbers?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"related-from-contacts": {
"links": {
"related": "/v2/contacts/0e561e6b-c76f-4df7-ae18-4c9248a7edbc/related-from-contacts"
}
},
"related-to-contacts": {
"data": [
{
"type": "contacts",
"id": "82c33b58-d09f-4b73-980a-8174730b8004"
},
{
"type": "contacts",
"id": "c0308a1b-e901-4f14-b59a-c2f974916f53"
},
{
"type": "contacts",
"id": "d97ec18b-767e-4904-879d-b2535e2f734c"
}
]
},
"to-contact-relationships": {
"links": {
"related": "/v2/contact-relationships?to-contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"uploaded-documents": {
"links": {
"related": "/v2/uploaded-documents?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc"
}
},
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"primary-address": {
"links": {
"related": "/v2/addresses/f1f2c09e-75ae-490e-bc4d-a9e6176140a2"
}
},
"primary-contact": {
"links": {
"related": "/v2/contacts/d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"primary-phone-number": {
"links": {
"related": "/v2/phone-numbers/a79d7690-619f-4287-96b9-eb2d681a7858"
}
},
"latest-cip-check": {
"links": {
"related": "/v2/cip-checks?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc&sort=-created-at&limit=1"
}
},
"latest-aml-check": {
"links": {
"related": "/v2/aml-checks?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc&sort=-created-at&limit=1"
}
},
"latest-kyc-document-check": {
"links": {
"related": "/v2/kyc-document-checks?contact.id=0e561e6b-c76f-4df7-ae18-4c9248a7edbc&sort=-created-at&limit=1"
}
}
}
},
"included": [
{
"type": "contacts",
"id": "82c33b58-d09f-4b73-980a-8174730b8004",
"attributes": {
"account-roles": [],
"aml-cleared": false,
"cip-cleared": false,
"contact-type": "company",
"date-of-birth": null,
"email": "support@bb.io",
"identity-confirmed": false,
"identity-documents-verified": false,
"name": "Parent Blockchain Company",
"proof-of-address-documents-verified": false,
"region-of-formation": "DW",
"sex": null,
"tax-country": "US",
"tax-id-number": "123123123",
"tax-state": "NV",
"type": "company",
"created-at": "2019-12-06T19:43:21Z",
"updated-at": "2019-12-06T19:43:21Z"
},
"links": {
"self": "/v2/contacts/82c33b58-d09f-4b73-980a-8174730b8004"
},
"relationships": {
"addresses": {
"links": {
"related": "/v2/addresses?contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"aml-checks": {
"links": {
"related": "/v2/aml-checks?contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"asset-transfers": {
"links": {
"related": "/v2/asset-transfers?contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"asset-transfer-methods": {
"links": {
"related": "/v2/asset-transfer-methods?contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"cip-checks": {
"links": {
"related": "/v2/cip-checks?contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"contact-funds-transfer-references": {
"links": {
"related": "/v2/contact-funds-transfer-references?contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"contributions": {
"links": {
"related": "/v2/contributions?contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"disbursements": {
"links": {
"related": "/v2/disbursements?contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"from-contact-relationships": {
"links": {
"related": "/v2/contact-relationships?from-contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"funds-transfer-methods": {
"links": {
"related": "/v2/funds-transfer-methods?contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"funds-transfers": {
"links": {
"related": "/v2/funds-transfers?contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"kyc-document-checks": {
"links": {
"related": "/v2/kyc-document-checks?contacts.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"payment-methods": {
"links": {
"related": "/v2/payment-methods?contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"phone-numbers": {
"links": {
"related": "/v2/phone-numbers?contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"related-from-contacts": {
"links": {
"related": "/v2/contacts/82c33b58-d09f-4b73-980a-8174730b8004/related-from-contacts"
}
},
"related-to-contacts": {
"data": []
},
"to-contact-relationships": {
"links": {
"related": "/v2/contact-relationships?to-contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"uploaded-documents": {
"links": {
"related": "/v2/uploaded-documents?contact.id=82c33b58-d09f-4b73-980a-8174730b8004"
}
},
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"primary-address": {
"links": {
"related": "/v2/addresses/b0734f34-2ac1-49ac-a8b2-d69d938a099d"
}
},
"primary-contact": {
"data": null
},
"primary-phone-number": {
"links": {
"related": "/v2/phone-numbers/e2538d87-6c40-4bf5-8678-02c2844b1310"
}
},
"latest-cip-check": {
"links": {
"related": "/v2/cip-checks?contact.id=82c33b58-d09f-4b73-980a-8174730b8004&sort=-created-at&limit=1"
}
},
"latest-aml-check": {
"links": {
"related": "/v2/aml-checks?contact.id=82c33b58-d09f-4b73-980a-8174730b8004&sort=-created-at&limit=1"
}
},
"latest-kyc-document-check": {
"links": {
"related": "/v2/kyc-document-checks?contact.id=82c33b58-d09f-4b73-980a-8174730b8004&sort=-created-at&limit=1"
}
}
}
},
{
"type": "contacts",
"id": "c0308a1b-e901-4f14-b59a-c2f974916f53",
"attributes": {
"account-roles": [],
"aml-cleared": false,
"cip-cleared": false,
"contact-type": "natural_person",
"date-of-birth": "1993-03-16",
"email": "james@bb.io",
"identity-confirmed": false,
"identity-documents-verified": false,
"name": "James Johnson",
"proof-of-address-documents-verified": false,
"region-of-formation": null,
"sex": "male",
"tax-country": "US",
"tax-id-number": "123123123",
"tax-state": "NV",
"type": "natural-person",
"created-at": "2019-12-06T19:43:21Z",
"updated-at": "2019-12-06T19:43:21Z"
},
"links": {
"self": "/v2/contacts/c0308a1b-e901-4f14-b59a-c2f974916f53"
},
"relationships": {
"addresses": {
"links": {
"related": "/v2/addresses?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"aml-checks": {
"links": {
"related": "/v2/aml-checks?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"asset-transfers": {
"links": {
"related": "/v2/asset-transfers?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"asset-transfer-methods": {
"links": {
"related": "/v2/asset-transfer-methods?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"cip-checks": {
"links": {
"related": "/v2/cip-checks?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"contact-funds-transfer-references": {
"links": {
"related": "/v2/contact-funds-transfer-references?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"contributions": {
"links": {
"related": "/v2/contributions?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"disbursements": {
"links": {
"related": "/v2/disbursements?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"from-contact-relationships": {
"links": {
"related": "/v2/contact-relationships?from-contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"funds-transfer-methods": {
"links": {
"related": "/v2/funds-transfer-methods?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"funds-transfers": {
"links": {
"related": "/v2/funds-transfers?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"kyc-document-checks": {
"links": {
"related": "/v2/kyc-document-checks?contacts.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"payment-methods": {
"links": {
"related": "/v2/payment-methods?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"phone-numbers": {
"links": {
"related": "/v2/phone-numbers?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"related-from-contacts": {
"links": {
"related": "/v2/contacts/c0308a1b-e901-4f14-b59a-c2f974916f53/related-from-contacts"
}
},
"related-to-contacts": {
"data": []
},
"to-contact-relationships": {
"links": {
"related": "/v2/contact-relationships?to-contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"uploaded-documents": {
"links": {
"related": "/v2/uploaded-documents?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53"
}
},
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"primary-address": {
"links": {
"related": "/v2/addresses/815d6c9d-b40d-4c14-bf11-34877621d1af"
}
},
"primary-contact": {
"data": null
},
"primary-phone-number": {
"links": {
"related": "/v2/phone-numbers/2e86f030-ab35-4304-b3e7-e5ddf3302d41"
}
},
"latest-cip-check": {
"links": {
"related": "/v2/cip-checks?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53&sort=-created-at&limit=1"
}
},
"latest-aml-check": {
"links": {
"related": "/v2/aml-checks?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53&sort=-created-at&limit=1"
}
},
"latest-kyc-document-check": {
"links": {
"related": "/v2/kyc-document-checks?contact.id=c0308a1b-e901-4f14-b59a-c2f974916f53&sort=-created-at&limit=1"
}
}
}
},
{
"type": "contacts",
"id": "d97ec18b-767e-4904-879d-b2535e2f734c",
"attributes": {
"account-roles": [],
"aml-cleared": false,
"cip-cleared": false,
"contact-type": "natural_person",
"date-of-birth": "1993-03-16",
"email": "jill@bb.io",
"identity-confirmed": false,
"identity-documents-verified": false,
"name": "Jill Johnson",
"proof-of-address-documents-verified": false,
"region-of-formation": null,
"sex": "female",
"tax-country": "US",
"tax-id-number": "123123123",
"tax-state": "NV",
"type": "natural-person",
"created-at": "2019-12-06T19:43:21Z",
"updated-at": "2019-12-06T19:43:21Z"
},
"links": {
"self": "/v2/contacts/d97ec18b-767e-4904-879d-b2535e2f734c"
},
"relationships": {
"addresses": {
"links": {
"related": "/v2/addresses?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"aml-checks": {
"links": {
"related": "/v2/aml-checks?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"asset-transfers": {
"links": {
"related": "/v2/asset-transfers?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"asset-transfer-methods": {
"links": {
"related": "/v2/asset-transfer-methods?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"cip-checks": {
"links": {
"related": "/v2/cip-checks?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"contact-funds-transfer-references": {
"links": {
"related": "/v2/contact-funds-transfer-references?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"contributions": {
"links": {
"related": "/v2/contributions?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"disbursements": {
"links": {
"related": "/v2/disbursements?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"from-contact-relationships": {
"links": {
"related": "/v2/contact-relationships?from-contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"funds-transfer-methods": {
"links": {
"related": "/v2/funds-transfer-methods?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"funds-transfers": {
"links": {
"related": "/v2/funds-transfers?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"kyc-document-checks": {
"links": {
"related": "/v2/kyc-document-checks?contacts.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"payment-methods": {
"links": {
"related": "/v2/payment-methods?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"phone-numbers": {
"links": {
"related": "/v2/phone-numbers?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"related-from-contacts": {
"links": {
"related": "/v2/contacts/d97ec18b-767e-4904-879d-b2535e2f734c/related-from-contacts"
}
},
"related-to-contacts": {
"data": []
},
"to-contact-relationships": {
"links": {
"related": "/v2/contact-relationships?to-contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"uploaded-documents": {
"links": {
"related": "/v2/uploaded-documents?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c"
}
},
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"primary-address": {
"links": {
"related": "/v2/addresses/2a0d612c-fc56-4bb0-8fc2-147a5d67ad15"
}
},
"primary-contact": {
"data": null
},
"primary-phone-number": {
"links": {
"related": "/v2/phone-numbers/deb74065-f87e-42b7-8400-53c56a42278d"
}
},
"latest-cip-check": {
"links": {
"related": "/v2/cip-checks?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c&sort=-created-at&limit=1"
}
},
"latest-aml-check": {
"links": {
"related": "/v2/aml-checks?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c&sort=-created-at&limit=1"
}
},
"latest-kyc-document-check": {
"links": {
"related": "/v2/kyc-document-checks?contact.id=d97ec18b-767e-4904-879d-b2535e2f734c&sort=-created-at&limit=1"
}
}
}
}
]
}

CIP checks and KYC document checks can be cleared in the sandbox environment as seen below. AML checks will clear themselves automatically in sandbox but there are endpoints that allow for them to cleared in sandbox as well.

Request

POST v2/cip-checks/{{cip-check-id}}/sandbox/approve

Response

{
"data": {
"type": "cip-checks",
"id": "782fed91-2fa5-47d6-b33a-a1a76f081e90",
"attributes": {
"created-at": "2019-12-03T17:21:05Z",
"exceptions": [
"manual_review_required"
],
"exception-details": null,
"status": "approved",
"updated-at": "2019-12-03T17:21:05Z"
},
"links": {
"self": "/v2/cip-checks/782fed91-2fa5-47d6-b33a-a1a76f081e90"
},
"relationships": {
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"contact": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd"
}
}
}
},
"included": []
}

Request

POST v2/kyc-document-checks/{{kyc-document-check-id}}/sandbox/verify

Response

{
"data": {
"type": "kyc-document-checks",
"id": "47a0f860-39a6-47ed-bec0-f28a6cc9eb1f",
"attributes": {
"created-at": "2019-12-03T17:37:49Z",
"expires-on": "2029-12-30",
"exceptions": [
"auto_check_failed"
],
"failure-details": null,
"identity": true,
"identity-photo": true,
"kyc-document-country": "US",
"kyc-document-other-type": null,
"kyc-document-type": "drivers_license",
"proof-of-address": true,
"status": "verified",
"updated-at": "2019-12-03T17:37:49Z"
},
"links": {
"self": "/v2/kyc-document-checks/47a0f860-39a6-47ed-bec0-f28a6cc9eb1f"
},
"relationships": {
"contact": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"uploaded-document": {
"links": {
"related": "/v2/uploaded-documents/8c9e8156-e787-4490-bbd8-995fd7342098"
}
},
"backside-document": {
"links": {
"related": "/v2/uploaded-documents/4d373402-1192-42d9-93f3-54a9c8851205"
}
}
}
},
"included": []
}

Trigger Sandbox CIP, AML and KYC exceptions

When creating a Contact or an Account with a Contact in Sandbox through POST /v2/contacts and POST /v2/accounts respectively, you have the ability to trigger CIP, AML and KYC checks using the Contact’s name attribute. The Contact’s name needs to be prefixed with sandbox_exceptions followed by a whitespace delimited string of desired exception codes that correspond to specific errors per type of check (shown below).

Example:

  • Contacts’s name: sandbox_exceptions 2 4
  • Result: This will create a Contact with a CIP check that has an exception attribute including deceased_auto_check_failed and an AML check with an exception attribute including currency_risk_auto_check_failed

List of available codes per Document check type

AML check

0 -> access_auto_check_failed
2 -> currency_risk_auto_check_failed
8 -> sanctions_screening_auto_check_failed

CIP check

0 -> access_auto_check_failed
1 -> address_auto_check_failed
3 -> date_of_birth_auto_check_failed
4 -> deceased_auto_check_failed
6 -> name_and_address_auto_check_failed
7 -> name_auto_check_failed
10 -> tax_id_number_auto_check_failed

KYC document check

0 -> access_auto_check_failed
1 -> address_auto_check_failed
3 -> date_of_birth_auto_check_failed
5 -> document_valid_auto_check_failed
9 -> tax_country_auto_check_failed
Last updated on