How do I create a customer?

Creating a customer is fairly straightforward. Simply navigate to the /api/customers POST API call and expand the entry.

When creating a new customer, there are two approaches you have to keep in mind. If you are using the Cybrid Platform for KYC, then you only need to specify the type of customer, which is individual in most cases. However, if you are using Partner Attestation for KYC, then you are required to provide additional PII information that you collected during your KYC verification process, which facilitates Cybrid's legal and regulatory requirements.

Customer Creation for the Cybrid Platform KYC Method

Make sure you are still authenticated, then click the Try it Out button, and click Execute. If the execution was successful you’ll see the details of the new customer object you created:

{
  "guid": "your-customer-guid",
  "bank_guid": "your-bank-guid",
  "type": "individual",
  "created_at": "2022-05-13T13:54:16.710Z",
  "state": "storing"
}

To verify the customer exists, you can navigate to the /api/customers GET API call, and click Execute to have all customers attached to your bank returned. The response will be similar to this:

{
  "total": 0,
  "page": 0,
  "per_page": 0,
  "objects": [
    {
      "guid": "your-customer-guid",
      "bank_guid": "your-bank-guid",
      "type": "individual",
      "created_at": "2022-05-13T13:55:08.460Z",
      "state": "unverified"
    }]
}

Note the state of the customer will be one of the following:

• storing - Indicates the platform is still storing the customer record
• unverified - Indicates the customer has been stored, and is ready to be verified

With the customer created, we can now move on to finalizing the customer's identity verification.

Customer Creation for the Partner Attestation KYC Method

Make sure you are still authenticated, then click the Try it Out button, and fill in the required customer PII as indicated below. Note that multiple identification numbers can be supplied as an array.

{
  "type": "individual",
  "name": {
    "first": "string",
    "middle": "string",
    "last": "string"
  },
  "address": {
    "street": "string",
    "street2": "string",
    "city": "string",
    "subdivision": "string",
    "postal_code": "string",
    "country_code": "string"
  },
  "date_of_birth": "2023-03-23",
  "phone_number": "string",
  "email_address": "string",
  "identification_numbers": [
    {
      "type": "drivers_license",
      "issuing_country_code": "string",
      "identification_number": "string"
    }
  ]
}

Once the details are filled out, click execute. If the execution was successful you’ll see the details of the new customer object you created:

{
  "guid": "your-customer-guid",
  "bank_guid": "your-bank-guid",
  "type": "individual",
  "created_at": "2022-05-13T13:54:16.710Z",
  "state": "storing"
}

To verify the customer exists, you can navigate to the /api/customers GET API call, and click Execute to have all customers attached to your bank returned. The response will be similar to this:

{
  "total": 0,
  "page": 0,
  "per_page": 0,
  "objects": [
    {
      "guid": "your-customer-guid",
      "bank_guid": "your-bank-guid",
      "type": "individual",
      "created_at": "2022-05-13T13:55:08.460Z",
      "state": "unverified"
    }
  ]
}

Note the state of the customer will be one of the following:

• storing - Indicates the platform is still storing the customer record
• unverified - Indicates the customer has been stored, and is ready to be verified

With the customer created, we can now move on to finalizing the customer's identity verification.