Creating a Customer

How do I create a customer?

Overview

Use the POST /api/customers endpoint to create a new customer.

When creating a customer, you have two approaches. If using Cybrid Platform for KYC, specify only the customer type (usually individual).

Customer Creation for the Cybrid Platform KYC Method

Use the POST /api/customers endpoint to create a new customer:

Creating an Individual Customer

Individual customers can be easily added to our platform. Note that all individual customers must go through Cybrid's KYC process.

{
  "type": "individual"
}

To verify the customer exists, you can navigate to the GET /api/customers endpoint 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"
    }]
}

Creating a Business Customer

Business customers can be easily added to our platform. Note that all business customers must go through Cybrid's KYB process.

{
  "type": "business"
}

To verify the customer exists, you can navigate to the GET /api/customers endpoint 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": "business",
      "created_at": "2022-05-13T13:55:08.460Z",
      "state": "unverified"
    }]
}

Customer States

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.