Create Customer

Create a new customer (individual or corporation). This operation will not perform KYC/KYB on your behalf, and is only available to regulated clients. For non regulated clients you must onboard via the application process

SecurityOAuth2: OAuth2Flow
Request
header Parameters
Authorization
string

OAuth bearer token (see authentication flows)

x-l2f-request-id
string

Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

x-l2f-idempotency-id
string

Unique ID used to safely retry an operation. See idempotency section for more details.

Request Body schema: application/json
id
required
string

Unique Identifier for the customer

customer_type
required
string

Type of customer

first_name
required
string

First name

middle_name
string

Middle Name(s) (if present)

last_name
required
string

Last name

email_address
string

Email Address

object (mailing_address)

Mailing Address

telephone_number
string

Telephone Number in E.164 format

tax_reference_number
string

Tax reference number of the individual (SSN, ITIN, SIN, National Insurance Number etc)

passport_number
string

Passport Number

nationality
string

Nationality (2 Digit ISO31661-Alpha2 Format - https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

date_of_birth
string <date>

RFC3339 (YYYY-MM-DD) Date of Birth

us_residency_status
string

US Residency Status

Enum: "US_CITIZEN" "RESIDENT_ALIEN" "NON_RESIDENT_ALIEN"
employment_status
string

Employment Status

Enum: "EMPLOYEE" "SELF_EMPLOYED" "RETIRED" "UNEMPLOYED" "OTHER"
employment_description
string

Employment (job) description.

employer_name
string

Employer name

occupation
string

Occupation

object (ProfileIndividualInvesting)

Investment Profile of the Individual

object (ProfileIndividualKYC)

KYC Profile of the Individual

Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Error

post/v1/customers
Request samples
application/json
{
  • "id": "string",
  • "customer_type": "INDIVIDUAL",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "email_address": "string",
  • "mailing_address": {
    },
  • "telephone_number": "string",
  • "tax_reference_number": "string",
  • "passport_number": "string",
  • "nationality": "string",
  • "date_of_birth": "2019-08-24",
  • "us_residency_status": "US_CITIZEN",
  • "employment_status": "EMPLOYEE",
  • "employment_description": "string",
  • "employer_name": "string",
  • "occupation": "string",
  • "investment_profile": {
    },
  • "kyc_profile": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}
© 2024 Rail. All Rights Reserved.