Create an end customer
curl --request POST \
--url https://api.yara.cash/v1/customers \
--header 'Content-Type: application/json' \
--header 'X-Idempotency-Key: <x-idempotency-key>' \
--header 'X-Yara-API-Key: <api-key>' \
--data '
{
"business_name": "Ada Labs Ltd",
"email": "customer@example.com",
"external_reference": "customer_001",
"first_name": "Ada",
"last_name": "Lovelace",
"type": "INDIVIDUAL"
}
'import requests
url = "https://api.yara.cash/v1/customers"
payload = {
"business_name": "Ada Labs Ltd",
"email": "customer@example.com",
"external_reference": "customer_001",
"first_name": "Ada",
"last_name": "Lovelace",
"type": "INDIVIDUAL"
}
headers = {
"X-Idempotency-Key": "<x-idempotency-key>",
"X-Yara-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Idempotency-Key': '<x-idempotency-key>',
'X-Yara-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
business_name: 'Ada Labs Ltd',
email: 'customer@example.com',
external_reference: 'customer_001',
first_name: 'Ada',
last_name: 'Lovelace',
type: 'INDIVIDUAL'
})
};
fetch('https://api.yara.cash/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yara.cash/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'business_name' => 'Ada Labs Ltd',
'email' => 'customer@example.com',
'external_reference' => 'customer_001',
'first_name' => 'Ada',
'last_name' => 'Lovelace',
'type' => 'INDIVIDUAL'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Idempotency-Key: <x-idempotency-key>",
"X-Yara-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yara.cash/v1/customers"
payload := strings.NewReader("{\n \"business_name\": \"Ada Labs Ltd\",\n \"email\": \"customer@example.com\",\n \"external_reference\": \"customer_001\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"type\": \"INDIVIDUAL\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
req.Header.Add("X-Yara-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yara.cash/v1/customers")
.header("X-Idempotency-Key", "<x-idempotency-key>")
.header("X-Yara-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"business_name\": \"Ada Labs Ltd\",\n \"email\": \"customer@example.com\",\n \"external_reference\": \"customer_001\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"type\": \"INDIVIDUAL\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yara.cash/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Idempotency-Key"] = '<x-idempotency-key>'
request["X-Yara-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"business_name\": \"Ada Labs Ltd\",\n \"email\": \"customer@example.com\",\n \"external_reference\": \"customer_001\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"type\": \"INDIVIDUAL\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"business_name": "<string>",
"capabilities": {},
"created_at": "<string>",
"email": "<string>",
"external_reference": "<string>",
"first_name": "<string>",
"id": "<string>",
"last_name": "<string>",
"rejection_reasons": [
"<string>"
],
"tier_1_complete": true,
"tier_2_complete": true,
"updated_at": "<string>"
}
}{
"data": {
"business_name": "<string>",
"capabilities": {},
"created_at": "<string>",
"email": "<string>",
"external_reference": "<string>",
"first_name": "<string>",
"id": "<string>",
"last_name": "<string>",
"rejection_reasons": [
"<string>"
],
"tier_1_complete": true,
"tier_2_complete": true,
"updated_at": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "invalid JSON body"
}
}{
"error": {
"code": "validation_error",
"message": "invalid JSON body"
}
}{
"error": {
"code": "validation_error",
"message": "invalid JSON body"
}
}{
"error": {
"code": "validation_error",
"message": "invalid JSON body"
}
}Customers
Create an end customer
Creates a merchant-owned customer and provisions the corresponding verification profile.
POST
/
v1
/
customers
Create an end customer
curl --request POST \
--url https://api.yara.cash/v1/customers \
--header 'Content-Type: application/json' \
--header 'X-Idempotency-Key: <x-idempotency-key>' \
--header 'X-Yara-API-Key: <api-key>' \
--data '
{
"business_name": "Ada Labs Ltd",
"email": "customer@example.com",
"external_reference": "customer_001",
"first_name": "Ada",
"last_name": "Lovelace",
"type": "INDIVIDUAL"
}
'import requests
url = "https://api.yara.cash/v1/customers"
payload = {
"business_name": "Ada Labs Ltd",
"email": "customer@example.com",
"external_reference": "customer_001",
"first_name": "Ada",
"last_name": "Lovelace",
"type": "INDIVIDUAL"
}
headers = {
"X-Idempotency-Key": "<x-idempotency-key>",
"X-Yara-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Idempotency-Key': '<x-idempotency-key>',
'X-Yara-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
business_name: 'Ada Labs Ltd',
email: 'customer@example.com',
external_reference: 'customer_001',
first_name: 'Ada',
last_name: 'Lovelace',
type: 'INDIVIDUAL'
})
};
fetch('https://api.yara.cash/v1/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yara.cash/v1/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'business_name' => 'Ada Labs Ltd',
'email' => 'customer@example.com',
'external_reference' => 'customer_001',
'first_name' => 'Ada',
'last_name' => 'Lovelace',
'type' => 'INDIVIDUAL'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Idempotency-Key: <x-idempotency-key>",
"X-Yara-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yara.cash/v1/customers"
payload := strings.NewReader("{\n \"business_name\": \"Ada Labs Ltd\",\n \"email\": \"customer@example.com\",\n \"external_reference\": \"customer_001\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"type\": \"INDIVIDUAL\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
req.Header.Add("X-Yara-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yara.cash/v1/customers")
.header("X-Idempotency-Key", "<x-idempotency-key>")
.header("X-Yara-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"business_name\": \"Ada Labs Ltd\",\n \"email\": \"customer@example.com\",\n \"external_reference\": \"customer_001\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"type\": \"INDIVIDUAL\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yara.cash/v1/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Idempotency-Key"] = '<x-idempotency-key>'
request["X-Yara-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"business_name\": \"Ada Labs Ltd\",\n \"email\": \"customer@example.com\",\n \"external_reference\": \"customer_001\",\n \"first_name\": \"Ada\",\n \"last_name\": \"Lovelace\",\n \"type\": \"INDIVIDUAL\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"business_name": "<string>",
"capabilities": {},
"created_at": "<string>",
"email": "<string>",
"external_reference": "<string>",
"first_name": "<string>",
"id": "<string>",
"last_name": "<string>",
"rejection_reasons": [
"<string>"
],
"tier_1_complete": true,
"tier_2_complete": true,
"updated_at": "<string>"
}
}{
"data": {
"business_name": "<string>",
"capabilities": {},
"created_at": "<string>",
"email": "<string>",
"external_reference": "<string>",
"first_name": "<string>",
"id": "<string>",
"last_name": "<string>",
"rejection_reasons": [
"<string>"
],
"tier_1_complete": true,
"tier_2_complete": true,
"updated_at": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "invalid JSON body"
}
}{
"error": {
"code": "validation_error",
"message": "invalid JSON body"
}
}{
"error": {
"code": "validation_error",
"message": "invalid JSON body"
}
}{
"error": {
"code": "validation_error",
"message": "invalid JSON body"
}
}Authorizations
Public merchant API key. You can also send Authorization: ApiKey .
Headers
Idempotency key
Body
application/json
Customer creation request
Response
Created
Show child attributes
Show child attributes
⌘I