Skip to main content
POST
/
customer
/
create
Create a new customer
curl --request POST \
  --url https://ramp-sandbox.hexarails.ai/customer/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "type": "DEPOSITOR",
  "isIndividual": true,
  "sumsubShareToken": "token123",
  "externalId": "partner-customer-001"
}
'
{
  "status": "SUCCESS",
  "data": {
    "id": "6ac34182-aa2e-4290-ab1b-302a09f451d1",
    "status": "PENDING",
    "sumsubLink": "https://sumsub.com/link"
  }
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
name
string
required

Customer name

Example:

"John Doe"

​
email
string
required

Customer email

Example:

"john.doe@example.com"

​
type
enum<string>

Customer type

Available options:
DEPOSITOR,
PAYEE
Example:

"DEPOSITOR"

​
isIndividual
boolean

Is individual

Example:

true

​
sumsubShareToken
string

Sumsub share token

Example:

"token123"

​
externalId
string

External customer identifier from partner system

Example:

"partner-customer-001"

Response

Create customer successful

​
status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

​
data
object
required

Response data