Skip to main content
POST
Create an end customer

Authorizations

X-Yara-API-Key
string
header
required

Your Yara API key. Send it in the X-Yara-API-Key header.

Headers

X-Idempotency-Key
string
required

Idempotency key

Body

application/json

Customer creation request

business_name
string
Example:

"Ada Labs Ltd"

email
string
Example:

"customer@example.com"

external_reference
string
Example:

"customer_001"

first_name
string
Example:

"Ada"

last_name
string
Example:

"Lovelace"

type
enum<string>
Available options:
INDIVIDUAL,
BUSINESS
Example:

"INDIVIDUAL"

Response

Created

data
object
required
error
string
required
message
string
required
Example:

"resource retrieved"

status
enum<string>
required
Available options:
success
Example:

"success"