Submit Employee KYC
curl --request POST \
--url https://api.yativo.com/api/v1/corporate-card/employees/kyc \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-Secret: <api-key>' \
--data '
{
"employee_id": "emp_456",
"full_name": "Jane Doe",
"id_type": "passport",
"id_number": "X1234567",
"dob": "1990-04-12",
"street": "100 Main St",
"city": "Miami",
"postal_code": "33101",
"gov_id_type": "passport",
"gov_id_number": "X1234567",
"state_id": 123,
"country_id": "US",
"nationality": "US",
"occupation": "<string>",
"gov_id_image": "<string>",
"gov_id_image_url": "https://example.com/id.jpg",
"payslip": "<string>",
"payslip_url": "<string>",
"proof_of_address": "<string>",
"proof_of_address_url": "<string>"
}
'import requests
url = "https://api.yativo.com/api/v1/corporate-card/employees/kyc"
payload = {
"employee_id": "emp_456",
"full_name": "Jane Doe",
"id_type": "passport",
"id_number": "X1234567",
"dob": "1990-04-12",
"street": "100 Main St",
"city": "Miami",
"postal_code": "33101",
"gov_id_type": "passport",
"gov_id_number": "X1234567",
"state_id": 123,
"country_id": "US",
"nationality": "US",
"occupation": "<string>",
"gov_id_image": "<string>",
"gov_id_image_url": "https://example.com/id.jpg",
"payslip": "<string>",
"payslip_url": "<string>",
"proof_of_address": "<string>",
"proof_of_address_url": "<string>"
}
headers = {
"X-Api-Key": "<api-key>",
"X-Api-Secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Api-Key': '<api-key>',
'X-Api-Secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
employee_id: 'emp_456',
full_name: 'Jane Doe',
id_type: 'passport',
id_number: 'X1234567',
dob: '1990-04-12',
street: '100 Main St',
city: 'Miami',
postal_code: '33101',
gov_id_type: 'passport',
gov_id_number: 'X1234567',
state_id: 123,
country_id: 'US',
nationality: 'US',
occupation: '<string>',
gov_id_image: '<string>',
gov_id_image_url: 'https://example.com/id.jpg',
payslip: '<string>',
payslip_url: '<string>',
proof_of_address: '<string>',
proof_of_address_url: '<string>'
})
};
fetch('https://api.yativo.com/api/v1/corporate-card/employees/kyc', 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.yativo.com/api/v1/corporate-card/employees/kyc",
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([
'employee_id' => 'emp_456',
'full_name' => 'Jane Doe',
'id_type' => 'passport',
'id_number' => 'X1234567',
'dob' => '1990-04-12',
'street' => '100 Main St',
'city' => 'Miami',
'postal_code' => '33101',
'gov_id_type' => 'passport',
'gov_id_number' => 'X1234567',
'state_id' => 123,
'country_id' => 'US',
'nationality' => 'US',
'occupation' => '<string>',
'gov_id_image' => '<string>',
'gov_id_image_url' => 'https://example.com/id.jpg',
'payslip' => '<string>',
'payslip_url' => '<string>',
'proof_of_address' => '<string>',
'proof_of_address_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>",
"X-Api-Secret: <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.yativo.com/api/v1/corporate-card/employees/kyc"
payload := strings.NewReader("{\n \"employee_id\": \"emp_456\",\n \"full_name\": \"Jane Doe\",\n \"id_type\": \"passport\",\n \"id_number\": \"X1234567\",\n \"dob\": \"1990-04-12\",\n \"street\": \"100 Main St\",\n \"city\": \"Miami\",\n \"postal_code\": \"33101\",\n \"gov_id_type\": \"passport\",\n \"gov_id_number\": \"X1234567\",\n \"state_id\": 123,\n \"country_id\": \"US\",\n \"nationality\": \"US\",\n \"occupation\": \"<string>\",\n \"gov_id_image\": \"<string>\",\n \"gov_id_image_url\": \"https://example.com/id.jpg\",\n \"payslip\": \"<string>\",\n \"payslip_url\": \"<string>\",\n \"proof_of_address\": \"<string>\",\n \"proof_of_address_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("X-Api-Secret", "<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.yativo.com/api/v1/corporate-card/employees/kyc")
.header("X-Api-Key", "<api-key>")
.header("X-Api-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"employee_id\": \"emp_456\",\n \"full_name\": \"Jane Doe\",\n \"id_type\": \"passport\",\n \"id_number\": \"X1234567\",\n \"dob\": \"1990-04-12\",\n \"street\": \"100 Main St\",\n \"city\": \"Miami\",\n \"postal_code\": \"33101\",\n \"gov_id_type\": \"passport\",\n \"gov_id_number\": \"X1234567\",\n \"state_id\": 123,\n \"country_id\": \"US\",\n \"nationality\": \"US\",\n \"occupation\": \"<string>\",\n \"gov_id_image\": \"<string>\",\n \"gov_id_image_url\": \"https://example.com/id.jpg\",\n \"payslip\": \"<string>\",\n \"payslip_url\": \"<string>\",\n \"proof_of_address\": \"<string>\",\n \"proof_of_address_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yativo.com/api/v1/corporate-card/employees/kyc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["X-Api-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"employee_id\": \"emp_456\",\n \"full_name\": \"Jane Doe\",\n \"id_type\": \"passport\",\n \"id_number\": \"X1234567\",\n \"dob\": \"1990-04-12\",\n \"street\": \"100 Main St\",\n \"city\": \"Miami\",\n \"postal_code\": \"33101\",\n \"gov_id_type\": \"passport\",\n \"gov_id_number\": \"X1234567\",\n \"state_id\": 123,\n \"country_id\": \"US\",\n \"nationality\": \"US\",\n \"occupation\": \"<string>\",\n \"gov_id_image\": \"<string>\",\n \"gov_id_image_url\": \"https://example.com/id.jpg\",\n \"payslip\": \"<string>\",\n \"payslip_url\": \"<string>\",\n \"proof_of_address\": \"<string>\",\n \"proof_of_address_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"status_code": 200,
"message": "Request successful",
"data": {
"employee_id": "<string>",
"full_name": "<string>",
"id_type": "<string>",
"id_number": "<string>",
"dob": "2023-12-25",
"street": "<string>",
"city": "<string>",
"state_id": 123,
"postal_code": "<string>",
"country_id": "<string>",
"nationality": "<string>",
"occupation": "<string>",
"gov_id_type": "<string>",
"gov_id_number": "<string>",
"gov_id_image_url": "<string>",
"payslip_url": "<string>",
"proof_of_address_url": "<string>",
"status": "pending",
"reject_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"status": "failed",
"status_code": 123,
"message": "Request failed.",
"data": {
"error": "<string>"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}{
"status": "failed",
"status_code": 123,
"message": "Request failed.",
"data": {
"error": "<string>"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}{
"status": "failed",
"status_code": 123,
"message": "Request failed.",
"data": {
"error": "<string>"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}{
"status": "failed",
"status_code": 123,
"message": "Request failed.",
"data": {
"error": "<string>"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}Corporate Cards
Submit Employee KYC
Submit or resubmit an employee’s identity details
POST
/
corporate-card
/
employees
/
kyc
Submit Employee KYC
curl --request POST \
--url https://api.yativo.com/api/v1/corporate-card/employees/kyc \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-Secret: <api-key>' \
--data '
{
"employee_id": "emp_456",
"full_name": "Jane Doe",
"id_type": "passport",
"id_number": "X1234567",
"dob": "1990-04-12",
"street": "100 Main St",
"city": "Miami",
"postal_code": "33101",
"gov_id_type": "passport",
"gov_id_number": "X1234567",
"state_id": 123,
"country_id": "US",
"nationality": "US",
"occupation": "<string>",
"gov_id_image": "<string>",
"gov_id_image_url": "https://example.com/id.jpg",
"payslip": "<string>",
"payslip_url": "<string>",
"proof_of_address": "<string>",
"proof_of_address_url": "<string>"
}
'import requests
url = "https://api.yativo.com/api/v1/corporate-card/employees/kyc"
payload = {
"employee_id": "emp_456",
"full_name": "Jane Doe",
"id_type": "passport",
"id_number": "X1234567",
"dob": "1990-04-12",
"street": "100 Main St",
"city": "Miami",
"postal_code": "33101",
"gov_id_type": "passport",
"gov_id_number": "X1234567",
"state_id": 123,
"country_id": "US",
"nationality": "US",
"occupation": "<string>",
"gov_id_image": "<string>",
"gov_id_image_url": "https://example.com/id.jpg",
"payslip": "<string>",
"payslip_url": "<string>",
"proof_of_address": "<string>",
"proof_of_address_url": "<string>"
}
headers = {
"X-Api-Key": "<api-key>",
"X-Api-Secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Api-Key': '<api-key>',
'X-Api-Secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
employee_id: 'emp_456',
full_name: 'Jane Doe',
id_type: 'passport',
id_number: 'X1234567',
dob: '1990-04-12',
street: '100 Main St',
city: 'Miami',
postal_code: '33101',
gov_id_type: 'passport',
gov_id_number: 'X1234567',
state_id: 123,
country_id: 'US',
nationality: 'US',
occupation: '<string>',
gov_id_image: '<string>',
gov_id_image_url: 'https://example.com/id.jpg',
payslip: '<string>',
payslip_url: '<string>',
proof_of_address: '<string>',
proof_of_address_url: '<string>'
})
};
fetch('https://api.yativo.com/api/v1/corporate-card/employees/kyc', 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.yativo.com/api/v1/corporate-card/employees/kyc",
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([
'employee_id' => 'emp_456',
'full_name' => 'Jane Doe',
'id_type' => 'passport',
'id_number' => 'X1234567',
'dob' => '1990-04-12',
'street' => '100 Main St',
'city' => 'Miami',
'postal_code' => '33101',
'gov_id_type' => 'passport',
'gov_id_number' => 'X1234567',
'state_id' => 123,
'country_id' => 'US',
'nationality' => 'US',
'occupation' => '<string>',
'gov_id_image' => '<string>',
'gov_id_image_url' => 'https://example.com/id.jpg',
'payslip' => '<string>',
'payslip_url' => '<string>',
'proof_of_address' => '<string>',
'proof_of_address_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>",
"X-Api-Secret: <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.yativo.com/api/v1/corporate-card/employees/kyc"
payload := strings.NewReader("{\n \"employee_id\": \"emp_456\",\n \"full_name\": \"Jane Doe\",\n \"id_type\": \"passport\",\n \"id_number\": \"X1234567\",\n \"dob\": \"1990-04-12\",\n \"street\": \"100 Main St\",\n \"city\": \"Miami\",\n \"postal_code\": \"33101\",\n \"gov_id_type\": \"passport\",\n \"gov_id_number\": \"X1234567\",\n \"state_id\": 123,\n \"country_id\": \"US\",\n \"nationality\": \"US\",\n \"occupation\": \"<string>\",\n \"gov_id_image\": \"<string>\",\n \"gov_id_image_url\": \"https://example.com/id.jpg\",\n \"payslip\": \"<string>\",\n \"payslip_url\": \"<string>\",\n \"proof_of_address\": \"<string>\",\n \"proof_of_address_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("X-Api-Secret", "<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.yativo.com/api/v1/corporate-card/employees/kyc")
.header("X-Api-Key", "<api-key>")
.header("X-Api-Secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"employee_id\": \"emp_456\",\n \"full_name\": \"Jane Doe\",\n \"id_type\": \"passport\",\n \"id_number\": \"X1234567\",\n \"dob\": \"1990-04-12\",\n \"street\": \"100 Main St\",\n \"city\": \"Miami\",\n \"postal_code\": \"33101\",\n \"gov_id_type\": \"passport\",\n \"gov_id_number\": \"X1234567\",\n \"state_id\": 123,\n \"country_id\": \"US\",\n \"nationality\": \"US\",\n \"occupation\": \"<string>\",\n \"gov_id_image\": \"<string>\",\n \"gov_id_image_url\": \"https://example.com/id.jpg\",\n \"payslip\": \"<string>\",\n \"payslip_url\": \"<string>\",\n \"proof_of_address\": \"<string>\",\n \"proof_of_address_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yativo.com/api/v1/corporate-card/employees/kyc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["X-Api-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"employee_id\": \"emp_456\",\n \"full_name\": \"Jane Doe\",\n \"id_type\": \"passport\",\n \"id_number\": \"X1234567\",\n \"dob\": \"1990-04-12\",\n \"street\": \"100 Main St\",\n \"city\": \"Miami\",\n \"postal_code\": \"33101\",\n \"gov_id_type\": \"passport\",\n \"gov_id_number\": \"X1234567\",\n \"state_id\": 123,\n \"country_id\": \"US\",\n \"nationality\": \"US\",\n \"occupation\": \"<string>\",\n \"gov_id_image\": \"<string>\",\n \"gov_id_image_url\": \"https://example.com/id.jpg\",\n \"payslip\": \"<string>\",\n \"payslip_url\": \"<string>\",\n \"proof_of_address\": \"<string>\",\n \"proof_of_address_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"status_code": 200,
"message": "Request successful",
"data": {
"employee_id": "<string>",
"full_name": "<string>",
"id_type": "<string>",
"id_number": "<string>",
"dob": "2023-12-25",
"street": "<string>",
"city": "<string>",
"state_id": 123,
"postal_code": "<string>",
"country_id": "<string>",
"nationality": "<string>",
"occupation": "<string>",
"gov_id_type": "<string>",
"gov_id_number": "<string>",
"gov_id_image_url": "<string>",
"payslip_url": "<string>",
"proof_of_address_url": "<string>",
"status": "pending",
"reject_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"status": "failed",
"status_code": 123,
"message": "Request failed.",
"data": {
"error": "<string>"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}{
"status": "failed",
"status_code": 123,
"message": "Request failed.",
"data": {
"error": "<string>"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}{
"status": "failed",
"status_code": 123,
"message": "Request failed.",
"data": {
"error": "<string>"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}{
"status": "failed",
"status_code": 123,
"message": "Request failed.",
"data": {
"error": "<string>"
},
"error_details": {
"code": "validation_error",
"message": "The amount field is required.",
"http_status": 422,
"fields": {},
"retryable": false,
"retry_after": 123
}
}Authorizations
Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.
Your API secret (yativo_sk_...), shown once when the key is created.
Body
application/jsonmultipart/form-data
Example:
"emp_456"
Maximum string length:
191Example:
"Jane Doe"
Maximum string length:
64Example:
"passport"
Maximum string length:
191Example:
"X1234567"
Example:
"1990-04-12"
Maximum string length:
255Example:
"100 Main St"
Maximum string length:
191Example:
"Miami"
Maximum string length:
32Example:
"33101"
Maximum string length:
64Example:
"passport"
Maximum string length:
191Example:
"X1234567"
Numeric id from List States. An unknown id returns 422.
ISO 3166-1 alpha-2.
Example:
"US"
ISO 3166-1 alpha-2.
Example:
"US"
Maximum string length:
191Example:
"https://example.com/id.jpg"

