Customers

Use this API to create a customer, update their details, and get their details.

Last updated 6 days ago

List customers

get

List all customers

Authorizations

Query parameters

pageTokenstring | nullableoptional

pageSizenumber · min: 1 · max: 100optional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.fernhq.com/customers' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

500

{
  "customers": [
    {
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "customerStatus": "created",
      "email": "name@gmail.com",
      "customerType": "INDIVIDUAL",
      "name": "text",
      "kycLink": "https://example.com",
      "updatedAt": "2025-04-02T04:09:57.804Z",
      "organizationId": "text"
    }
  ],
  "nextPageToken": "text"
}

Default Response

Get customer

get

Get details about a customer

Authorizations

Path parameters

customerIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.fernhq.com/customers/{customerId}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

500

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerStatus": "created",
  "email": "name@gmail.com",
  "customerType": "INDIVIDUAL",
  "name": "text",
  "kycLink": "https://example.com",
  "updatedAt": "2025-04-02T04:09:57.804Z",
  "organizationId": "text"
}

Default Response

Create customer

post

Upon successful customer creation, a hosted KYC link requesting the required information to fill in will be generated. This may be distributed to your end-user for completion, or it can be completed on the customer's behalf by your team.

Authorizations

Body

customerTypestring · enumrequired

Available options:

firstNamestringoptional

lastNamestringoptional

businessNamestringoptional

emailstringrequired

Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.fernhq.com/customers' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "customerType": "INDIVIDUAL",
    "firstName": "text",
    "lastName": "text",
    "businessName": "text",
    "email": "text"
  }'

201

400

401

403

404

500

{
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "customerStatus": "created",
  "email": "name@gmail.com",
  "customerType": "INDIVIDUAL",
  "name": "text",
  "kycLink": "https://example.com",
  "updatedAt": "2025-04-02T04:09:57.804Z",
  "organizationId": "text"
}

Default Response