Skip to main content
GET
/
customers
/
{customerId}
Get customer
curl --request GET \
  --url https://api.fernhq.com/customers/{customerId} \
  --header 'Authorization: Bearer <token>'
{ "customerId": "abc123", "customerStatus": "ACTIVE", "email": "john.doe@example.com", "customerType": "INDIVIDUAL", "name": "John Doe", "verificationLink": "https://forms.fernhq.com/verify-customer/0423300f-ae6d-4e82-8afb-a3b430e22e29", "updatedAt": "2023-11-07T05:31:56Z", "organizationId": "8469411c-48c1-4e26-a032-44688be9cb4b", "availablePaymentMethods": [ "ACH", "WIRE", "SEPA", "CA_INTERAC", "IN_NEFT_RTGS_IMPS", "ARBITRUM", "BASE", "ETHEREUM", "OPTIMISM", "POLYGON", "SOLANA" ], "verificationIssues": [ { "code": "DOCUMENT_MISSING_BACK", "message": "Please upload clear photos of both the front and back of your ID.", "timestamp": "2023-10-01T12:00:00Z" } ], "kycData": { "legalFirstName": "John", "legalMiddleName": "Michael", "legalLastName": "Doe", "phoneNumber": "+12223334444", "dateOfBirth": "1990-01-15", "nationalIdIssuingCountry": "US", "nationalIdType": "ssn", "nationalIdNumber": "123-45-6789", "nationality": "US", "employmentStatus": "EMPLOYED", "mostRecentOccupation": "132011", "sourceOfFunds": "SALARY", "accountPurpose": "PERSONAL_EXPENSES", "accountPurposeOther": "Real estate transactions", "expectedMonthlyPaymentsUsd": "BETWEEN_10000_49999", "isIntermediary": false, "documents": [ { "type": "DRIVERS_LICENSE_FRONT", "frontIdImage": "data:image/png;base64,iVBORw0KGgoAAA...", "backIdImage": "data:image/png;base64,iVBORw0KGgoAAA...", "proofOfAddressImage": "data:application/pdf;base64,JVBERi0xLjQKJ...", "documentImage": "data:application/pdf;base64,JVBERi0xLjQKJ..." } ] } }

Authorizations

​
Authorization
string
header
required

To authenticate server-side requests

Path Parameters

​
customerId
string<uuid>
required

Unique identifier of the customer

Query Parameters

​
includeVerification
boolean
default:false

Whether to include verification details

​
includePaymentMethods
boolean
default:false

Whether to include available payment methods in the response

Response

Developer API customer response including optional KYC/KYB verification data.

Developer API customer response including optional KYC/KYB verification data.

​
customerId
string<uuid>
required

Unique identifier of the customer

Example:

"abc123"

​
customerStatus
enum<string>
required

Current status of the customer

Available options:
CREATED,
UNDER_REVIEW,
NEEDS_ADDITIONAL_INFORMATION,
ACTIVE,
REJECTED,
DEACTIVATED
Example:

"ACTIVE"

​
email
string<email>
required

Email of the customer

Example:

"john.doe@example.com"

​
customerType
enum<string>
required

The type of customer - either individual or business

Available options:
INDIVIDUAL,
BUSINESS
​
name
string
required

Full name of the customer or business

Example:

"John Doe"

​
verificationLink
string<uri>
required

URL for KYC/KYB verification process

Example:

"https://forms.fernhq.com/verify-customer/0423300f-ae6d-4e82-8afb-a3b430e22e29"

​
updatedAt
string<date-time>
required

Timestamp of the last status update

​
organizationId
string
required

Organization identifier

Example:

"8469411c-48c1-4e26-a032-44688be9cb4b"

​
availablePaymentMethods
string[]

Available payment methods for the customer

Example:
[
  "ACH",
  "WIRE",
  "SEPA",
  "CA_INTERAC",
  "IN_NEFT_RTGS_IMPS",
  "ARBITRUM",
  "BASE",
  "ETHEREUM",
  "OPTIMISM",
  "POLYGON",
  "SOLANA"
]
​
verificationIssues
Verification Issue · object[]

Current verification issues blocking customer approval. Only present for customers in NEEDS_ADDITIONAL_INFORMATION, UNDER_REVIEW, or REJECTED status.

Example:
[
  {
    "code": "DOCUMENT_MISSING_BACK",
    "message": "Please upload clear photos of both the front and back of your ID.",
    "timestamp": "2023-10-01T12:00:00Z"
  }
]
​
kycData
KYC Data · object

Know Your Customer data for an individual.

​
kybData
KYB Data · object

Know Your Business data for a business entity.