Individual KYC API Reference

Full API Reference

Create Individual Customer

POST /v1/customers

Creates a new individual customer record.

Request Body:

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+12025551234",
  "birthDate": "1990-05-15"
}

Response:

{
  "id": "cust_abc123",
  "type": "individual",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "phone": "+12025551234",
  "birthDate": "1990-05-15",
  "status": "not_started",
  "balance": 0,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Initiate KYC Verification

POST /v1/customers/{id}/kyc

Initiates KYC verification for the customer. Returns a URL where the customer can complete identity verification.

Response:

{
  "verificationUrl": "https://verify.swipelux.com/session/xyz789"
}

The customer should be redirected to the verificationUrl to complete the verification process. The verification form will collect:

ID document upload
Selfie/liveness check
Any additional required information

The verification URL is valid for 24 hours. After expiration, you'll need to initiate a new KYC session.

Get Customer Status

GET /v1/customers/{id}

Retrieves the current customer record including verification status.

Response:

{
  "id": "cust_abc123",
  "type": "individual",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "status": "approved",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T14:30:00Z"
}

Update Customer

PUT /v1/customers/{id}

Updates customer information. Can be used to add additional details before or after KYC verification.

Request Body:

{
  "phone": "+12025559999",
  "residentialAddress": {
    "streetLine1": "123 Main St",
    "city": "New York",
    "state": "NY",
    "country": "US",
    "postalCode": "10001"
  }
}

Residential Address Object

Field	Type	Required	Description
`streetLine1`	string	Yes	Street address line 1
`streetLine2`	string	No	Street address line 2
`city`	string	Yes	City
`state`	string	Yes	State/Province/Region
`country`	string	Yes	Country (ISO 3166-1 alpha-2)
`postalCode`	string	No	Postal/ZIP code

Identifying Information Object

Field	Type	Required	Description
`type`	string	Yes	Document type (passport, drivers_license, id_card)
`issuingCountry`	string	Yes	Country that issued the ID (ISO 3166-1 alpha-2)
`frontSideImage`	string	No	Base64-encoded front image
`backSideImage`	string	No	Base64-encoded back image

API Reference

Individual KYC API Reference

Full API Reference

Create Individual Customer

Initiate KYC Verification

Get Customer Status

Update Customer

Residential Address Object

Identifying Information Object

On this page