Customers

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

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

Request payload for creating a new customer account

customerTypeany ofRequired

The type of customer - either individual or business

string · enumOptionalPossible values:
or
string · enumOptionalPossible values:
firstNamestringOptional

First name of the customer

Example: John
lastNamestringOptional

Last name of the customer

Example: Doe
businessNamestringOptional

Name of the business

Example: John Doe Inc.
emailstring · emailRequired

Email of the customer

Example: john.doe@example.com
Responses
201
Response schema for a customer retrieval request
application/json
post
POST /customers HTTP/1.1
Host: api.fernhq.com
Authorization: Bearer API Key
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "customerType": "INDIVIDUAL",
  "firstName": "John",
  "lastName": "Doe",
  "businessName": "John Doe Inc.",
  "email": "john.doe@example.com"
}
{
  "customerId": "03b7030f-6da1-4d76-9352-cdebd82112c8",
  "customerStatus": "ACTIVE",
  "customerType": "INDIVIDUAL",
  "name": "John Doe",
  "email": "johndoe@example.com",
  "kycLink": "https://kyb.example.com/verify/abc123",
  "updatedAt": "2023-10-01T12:00:00Z",
  "organizationId": "8469411c-48c1-4e26-a032-44688be9cb4b"
}

Get customer

get

Get details about a customer

Authorizations
Path parameters
customerIdstring · uuidRequired

Unique identifier of the customer

Example: 03b7030f-6da1-4d76-9352-cdebd82112c8
Responses
200
Response schema for a customer retrieval request
application/json
get
GET /customers/{customerId} HTTP/1.1
Host: api.fernhq.com
Authorization: Bearer API Key
Accept: */*

{
  "customerId": "03b7030f-6da1-4d76-9352-cdebd82112c8",
  "customerStatus": "ACTIVE",
  "customerType": "INDIVIDUAL",
  "name": "John Doe",
  "email": "johndoe@example.com",
  "kycLink": "https://kyb.example.com/verify/abc123",
  "updatedAt": "2023-10-01T12:00:00Z",
  "organizationId": "8469411c-48c1-4e26-a032-44688be9cb4b"
}

List customers

get

List all customers

Authorizations
Query parameters
pageTokenstringOptional

Page token to fetch entries after

Example: abc
pageSizeinteger · min: 1 · max: 100Optional

Number of entries to fetch

Example: 10
Responses
200
Default Response
application/json
get
GET /customers HTTP/1.1
Host: api.fernhq.com
Authorization: Bearer API Key
Accept: */*

{
  "customers": [
    {
      "customerId": "03b7030f-6da1-4d76-9352-cdebd82112c8",
      "customerStatus": "ACTIVE",
      "customerType": "INDIVIDUAL",
      "name": "John Doe",
      "email": "johndoe@example.com",
      "kycLink": "https://kyb.example.com/verify/abc123",
      "updatedAt": "2023-10-01T12:00:00Z",
      "organizationId": "8469411c-48c1-4e26-a032-44688be9cb4b"
    }
  ],
  "nextPageToken": "xyz"
}

Last updated