Skip to main content
PATCH
/
customers
/
{customerId}
Update customer KYC data
curl --request PATCH \
  --url https://api.fernhq.com/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "kycData": {
    "legalFirstName": "John",
    "legalMiddleName": "Michael",
    "middleName": "Michael",
    "legalLastName": "Doe",
    "phoneNumber": "+12223334444",
    "dateOfBirth": "1990-01-15",
    "address": {
      "countryCode": "US",
      "streetLine1": "350 5th Avenue",
      "streetLine2": "Floor 21",
      "city": "New York",
      "stateRegionProvince": "NY",
      "postalCode": "10016",
      "locale": "en-US"
    },
    "taxIdNumber": "123-45-6789",
    "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,
    "title": "Mr.",
    "documents": [
      {
        "type": "GOVERNMENT_ID",
        "subtype": "NATIONAL_ID",
        "countryCode": "US",
        "documentIdNumber": "123456789",
        "issuanceDate": "2020-01-15",
        "expirationDate": "2030-01-15",
        "frontIdImage": "<string>",
        "backIdImage": "<string>",
        "proofOfAddressImage": "<string>",
        "description": "Electric bill from January 2024"
      }
    ]
  },
  "kybData": {
    "businessInfo": {
      "legalBusinessName": "Acme Corporation Inc.",
      "dbaName": "Acme Corp",
      "businessType": "CORPORATION",
      "businessIndustries": "611519",
      "businessDescription": "Software development and technology consulting services",
      "website": "https://www.acmecorp.com",
      "otherLinks": [
        "https://linkedin.com/company/acme",
        "@acmetech"
      ],
      "formationDate": "2020-01-15",
      "registrationCountry": "DE",
      "isDao": false
    },
    "businessRegisteredAddress": {
      "countryCode": "US",
      "streetLine1": "350 5th Avenue",
      "streetLine2": "Floor 21",
      "city": "New York",
      "stateRegionProvince": "NY",
      "postalCode": "10016",
      "locale": "en-US"
    },
    "businessOperatingAddress": {
      "countryCode": "US",
      "streetLine1": "350 5th Avenue",
      "streetLine2": "Floor 21",
      "city": "New York",
      "stateRegionProvince": "NY",
      "postalCode": "10016",
      "locale": "en-US"
    },
    "businessRegistrationNumber": "<string>",
    "sourceOfFunds": "SALE_OF_GOODS_AND_SERVICES",
    "sourceOfFundsDescription": "Revenue from software licensing and consulting services",
    "accountPurpose": "CHARITABLE_DONATIONS",
    "accountPurposeOther": "International trade financing",
    "expectedMonthlyVolumeUsd": "LESS_THAN_10000",
    "estimatedAnnualRevenueUsd": "LESS_THAN_100000",
    "conductsMoneyServices": false,
    "conductsMoneyServicesDescription": "International wire transfers for clients",
    "conductsMoneyServicesThroughFern": false,
    "operatesInProhibitedCountries": false,
    "complianceScreeningDescription": "We screen all clients against OFAC and international sanctions lists",
    "highRiskActivities": [
      "ADULT_ENTERTAINMENT",
      "FOREIGN_EXCHANGE_OR_BROKERAGE"
    ],
    "highRiskActivitiesExplanation": "We operate an adult entertainment platform with proper licensing and compliance measures in place.",
    "associatedPersons": [
      {
        "legalFirstName": "Jane",
        "legalMiddleName": "Marie",
        "legalLastName": "Smith",
        "email": "jane.smith@example.com",
        "phoneNumber": "+14155551234",
        "dateOfBirth": "1985-06-20",
        "address": {
          "countryCode": "US",
          "streetLine1": "350 5th Avenue",
          "streetLine2": "Floor 21",
          "city": "New York",
          "stateRegionProvince": "NY",
          "postalCode": "10016",
          "locale": "en-US"
        },
        "ownershipPercentage": 0.25,
        "title": "Chief Technology Officer",
        "isControlPerson": true,
        "isSigner": true,
        "isDirector": false,
        "nationalIdIssuingCountry": "US",
        "nationalIdType": "ssn",
        "nationalIdNumber": "123-45-6789",
        "nationality": "US",
        "documents": [
          {
            "type": "GOVERNMENT_ID",
            "subtype": "NATIONAL_ID",
            "countryCode": "US",
            "documentIdNumber": "123456789",
            "issuanceDate": "2020-01-15",
            "expirationDate": "2030-01-15",
            "frontIdImage": "<string>",
            "backIdImage": "<string>",
            "proofOfAddressImage": "<string>",
            "description": "Bank statement for KYB associated person"
          }
        ]
      }
    ],
    "businessDocuments": [
      {
        "type": "ARTICLES_OF_INCORPORATION",
        "description": "Articles of Incorporation filed in Delaware",
        "documentImage": "<string>"
      }
    ]
  }
}'
{
  "customerId": "03b7030f-6da1-4d76-9352-cdebd82112c8",
  "customerStatus": "ACTIVE",
  "customerType": "INDIVIDUAL",
  "name": "John Doe",
  "email": "johndoe@example.com",
  "kycLink": "https://app.fernhq.com/verify-customer/03b7030f-6da1-4d76-9352-cdebd82112c8",
  "verificationLink": "https://app.fernhq.com/verify-customer/03b7030f-6da1-4d76-9352-cdebd82112c8",
  "updatedAt": "2023-10-01T12:00:00Z",
  "organizationId": "8469411c-48c1-4e26-a032-44688be9cb4b"
}

Authorizations

​
Authorization
string
header
required

To authenticate server-side requests

Path Parameters

​
customerId
string<uuid>
required

Unique identifier of the customer

Body

application/json

Payload for customer KYC data partial update

​
kycData
object

Know Your Customer verification data (patch schema)

​
kybData
object

Know Your Business verification data (patch schema)

Response

Response schema for a customer retrieval request

​
customerId
string<uuid>
required

Unique identifier of the customer

Example:

"abc123"

​
customerStatus
required

Current status of the customer

Available options:
CREATED
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://app.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"

​
kycLink
string<uri>
deprecated

URL for KYC/KYB verification process (DEPRECATED: Use verificationLink instead)

Example:

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