POST
/
api
/
v2.1
/
customer
/
create
curl --request POST \
  --url https://sandbox.finhub.cloud/api/v2.1/customer/create \
  --header 'Content-Type: application/json' \
  --header 'X-Forwarded-For: <x-forwarded-for>' \
  --data '{
  "organizationId": "<string>",
  "customerType": "<string>",
  "customerName": "<string>",
  "customerStatus": "<string>",
  "categorization": "<string>",
  "person": {
    "firstName": {
      "order": 123,
      "name": "<string>",
      "abbreviation": "<string>",
      "language": "<string>",
      "nativeName": "<string>",
      "suffix": "<string>",
      "prefix": "<string>"
    },
    "lastName": {
      "order": 123,
      "name": "<string>",
      "abbreviation": "<string>",
      "language": "<string>",
      "nativeName": "<string>",
      "suffix": "<string>",
      "prefix": "<string>"
    },
    "gender": "<string>",
    "dateOfBirth": "2022-03-10T00:00:00.000Z",
    "placeOfBirth": "<string>",
    "nationality": "<string>",
    "email": "<string>",
    "pincode": "<string>",
    "telephoneNumbers": [
      {
        "phoneType": "<string>",
        "number": "<string>",
        "encoding": "<string>"
      }
    ],
    "organizationRole": "<string>"
  },
  "sourceData": "<string>",
  "sepaId": "<string>",
  "ownerId": "<string>",
  "sharePercentage": 123,
  "ultimatePercentage": 123,
  "nextKycPepCheckDate": "2022-03-10T00:00:00.000Z",
  "externalCustomerId": "<string>",
  "idProofExpiryDate": "2022-03-10T00:00:00.000Z",
  "isB2B": true,
  "isDirector": true,
  "kycCheckStatus": "<string>",
  "pepCheckResult": "<string>",
  "kycConfirmation": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "data": "<any>"
}

Headers

X-Forwarded-For
string
required

Forwarded client IP address

User-Agent
string

Client user agent information

X-Tenant-ID
string

Tenant identifier for multi-tenant operations

Body

application/json

Response

200
application/json

Customer created successfully

The response is of type object.