GuidesRecipesAPI ReferenceChangelog
Guides

Creating a Customer

How do I create a customer?

Overview

Use the POST /api/customers endpoint to create a new customer. If using Cybrid Platform for KYC, specify only the customer type (individual or business).

Creating an Individual Customer

All individual customers must complete Cybrid's KYC process.

{
  "type": "individual"
}

To verify the customer exists, call GET /api/customers to list all customers attached to your bank. The response includes:

{
  "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

All business customers must complete Cybrid's KYB process.

{
  "type": "business"
}

To verify the customer exists, call GET /api/customers. The response includes:

{
  "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

A customer progresses through these states:

  • storing -- The platform is still storing the customer record.
  • unverified -- The customer has been stored and is ready for identity verification.
  • verified -- The customer has passed identity verification.
  • rejected -- The customer failed identity verification.
  • frozen -- The customer account has been frozen.

After creating a customer, proceed to identity verification.