UnblockPayGuideReference

Customers

Understanding CustomersCopied!

Customers are users of your business who can be either individuals or businesses.

Before making any transactions, all users must be registered as customers through UnblockPay's Customers API and go through a KYC or KYB process to verify their identity. Once approved with UnblockPay, customers can seamlessly transfer stablecoins or fiat currencies between wallets and bank accounts.


Compliance and Identity ChecksCopied!

UnblockPay manages all Know Your Customer (“KYC”) and Know Your Business (“KYB”) checks to ensure secure transfers. We will inform you if additional information is needed from your users to complete this process.

When a payment is initiated, the customer is recorded as the originator of funds.

KYC and KYB verification processes include collecting essential information such as:

Individuals

Businesses

First name

Legal name

Last name

Document type

Document type

Tax ID or Government-Issued Number

Tax ID or Government-Issued Number

Email

Date of birth

Phone

Email

Country

Phone

Address

Country

Address

KYC and KYB may not be available for Customers in specific jurisdictions.

Some fiat ramps – such as USD and EUR – may require enhanced KYC and KYB documentation. Contact our team to enable these payment rails.


Customers API endpointsCopied!

Here are the endpoints you'll need to create or manage a customer:

  • POST /customers: Create a new customer

  • GET /customers: List all customers

  • GET /customers/{id}: Get specific details for one customer


How to create a Customer?Copied!

POST /customer

This endpoint lets you create customer profiles that represent your business users. You must create a customer in UnblockPay before processing any pay-ins or payouts.

To create a new Customer, send a POST request to the Customer endpoint with the required fields in the request body, specifying either individual or business as the customer type.

Here is a request example for creating an individual customer:

curl https://api.unblockpay.com/customers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: YOUR_SECRET_TOKEN' \
  --data '{
    "type": "individual",
    "first_name": "Satoshi",
    "last_name": "Nakamoto",
    "email": "satoshi@email.com",
    "phone_number": "1234567890",
    "date_of_birth": "1990-01-01",
    "identity_documents": [
      {
        "type": "national_id",
        "value": "12345678900",
        "country": "BR"
      }
    ],
    "address": {
      "street_line_1": "123 Main St",
      "street_line_2": "Apt 4B",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "USA"
    }
 }'

Here is a request example for creating an business customer:

curl https://api.unblockpay.com/customers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: YOUR_SECRET_TOKEN' \
  --data '{
    "type": "business",
    "business_legal_name": "Satoshi Company LLC",
    "email": "satoshi@email.com",
    "phone_number": "1234567890",
    "identity_documents": [
      {
        "type": "tax_id",
        "value": "96585813000160",
        "country": "BR"
      }
    ],
    "address": {
      "street_line_1": "123 Main St",
      "street_line_2": "Apt 4B",
      "city": "São Paulo",
      "state": "SP",
      "postal_code": "04514-100",
      "country": "BR"
    }
 }'

The identity_documents object will include:

Parameter

Description

type

For individuals, the acceptable document types are:

  • passport

  • national_id

  • driver_license

For businesses, only tax_id is accepted.

value

This field contains the customer's document number and must be provided as a string.

country

This indicates the country where the document was issued.

Here is a response example when creating an individual customer:

{
  "id": "0196c8cd-839a-7389-b5ce-0a0776023e55",
  "status": "approved",
  "type": "individual",
  "first_name": "Satoshi",
  "last_name": "Nakamoto",
  "email": "satoshi@email.com",
  "phone_number": "1234567890",
  "date_of_birth": "1990-01-01",
  "identity_documents": [
    {
      "type": "national_id",
      "value": "12345678900",
      "country": "BR"
    }
  ],
  "address": {
    "street_line_1": "123 Main St",
    "street_line_2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001",
    "country": "USA"
  }
  "created_at": "2025-05-13T08:40:33.946Z",
  "updated_at": "2025-05-13T12:26:53.405Z"
}

Here is a response example when creating a business customer:

{
  "id": "0196c8cd-839a-7389-b5ce-0a0776023e55",
  "status": "approved",
  "type": "business",
  "business_legal_name": "Satoshi Company LLC",
  "email": "satoshi@email.com",
  "phone_number": "1234567890"
  "identity_documents": [
    {
      "type": "tax_id",
      "value": "96585813000160",
      "country": "BR"
    }
  ],
  "address": {
    "street_line_1": "123 Main St",
    "street_line_2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001",
    "country": "USA"
  }
  "created_at": "2025-05-13T08:40:33.946Z",
  "updated_at": "2025-05-13T12:26:53.405Z"
}