Create a kyb
curl --request POST \
--url https://api.example.com/compliance/kyb \
--header 'ApiKey: <apikey>' \
--header 'Content-Type: application/json' \
--header 'Environment: <environment>' \
--header 'MerchantId: <merchantid>' \
--data '
{
"merchantId": "156",
"name": "Example merchant",
"businessType": "Fintech",
"businessRegistrationId": "<string>",
"taxNumber": "<string>",
"directorName": "<string>",
"websiteUrl": "<string>",
"country": "CI",
"headquarterAddress": "<string>"
}
'import requests
url = "https://api.example.com/compliance/kyb"
payload = {
"merchantId": "156",
"name": "Example merchant",
"businessType": "Fintech",
"businessRegistrationId": "<string>",
"taxNumber": "<string>",
"directorName": "<string>",
"websiteUrl": "<string>",
"country": "CI",
"headquarterAddress": "<string>"
}
headers = {
"ApiKey": "<apikey>",
"MerchantId": "<merchantid>",
"Environment": "<environment>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
ApiKey: '<apikey>',
MerchantId: '<merchantid>',
Environment: '<environment>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
merchantId: '156',
name: 'Example merchant',
businessType: 'Fintech',
businessRegistrationId: '<string>',
taxNumber: '<string>',
directorName: '<string>',
websiteUrl: '<string>',
country: 'CI',
headquarterAddress: '<string>'
})
};
fetch('https://api.example.com/compliance/kyb', 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.example.com/compliance/kyb",
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([
'merchantId' => '156',
'name' => 'Example merchant',
'businessType' => 'Fintech',
'businessRegistrationId' => '<string>',
'taxNumber' => '<string>',
'directorName' => '<string>',
'websiteUrl' => '<string>',
'country' => 'CI',
'headquarterAddress' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"ApiKey: <apikey>",
"Content-Type: application/json",
"Environment: <environment>",
"MerchantId: <merchantid>"
],
]);
$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.example.com/compliance/kyb"
payload := strings.NewReader("{\n \"merchantId\": \"156\",\n \"name\": \"Example merchant\",\n \"businessType\": \"Fintech\",\n \"businessRegistrationId\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"directorName\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"country\": \"CI\",\n \"headquarterAddress\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ApiKey", "<apikey>")
req.Header.Add("MerchantId", "<merchantid>")
req.Header.Add("Environment", "<environment>")
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.example.com/compliance/kyb")
.header("ApiKey", "<apikey>")
.header("MerchantId", "<merchantid>")
.header("Environment", "<environment>")
.header("Content-Type", "application/json")
.body("{\n \"merchantId\": \"156\",\n \"name\": \"Example merchant\",\n \"businessType\": \"Fintech\",\n \"businessRegistrationId\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"directorName\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"country\": \"CI\",\n \"headquarterAddress\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/compliance/kyb")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"merchantId\": \"156\",\n \"name\": \"Example merchant\",\n \"businessType\": \"Fintech\",\n \"businessRegistrationId\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"directorName\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"country\": \"CI\",\n \"headquarterAddress\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"merchantId": "156",
"name": "Example merchant",
"businessType": "Fintech",
"businessRegistrationId": "<string>",
"taxNumber": "<string>",
"directorName": "<string>",
"websiteUrl": "<string>",
"country": "CI",
"headquarterAddress": "<string>",
"id": 1,
"createdAt": "2020-10-15T12:09:49.355Z",
"deletedAt": null
}{
"status": 400,
"error": {
"statusCode": 400,
"message": [
"destination.provider must be a string"
],
"error": "Bad Request"
}
}{
"status": 401,
"error": {
"type": "authorization_error",
"code": "wrong_credentials",
"message": "L'ID marchand et/ou la clé d'API sont incorrects."
}
}{
"httpStatus": 409,
"type": "invalid_request",
"code": "unsupported_action",
"message": "This action is not supported"
}{
"type": "internal_error",
"code": [
"internal_error",
"wrong_credentials",
"not_granted",
"live_mode_not_granted",
"merchant_inactive"
],
"message": "An error occurred on our system. Please try again later."
}Compliance
Create a kyb
POST
/
compliance
/
kyb
Create a kyb
curl --request POST \
--url https://api.example.com/compliance/kyb \
--header 'ApiKey: <apikey>' \
--header 'Content-Type: application/json' \
--header 'Environment: <environment>' \
--header 'MerchantId: <merchantid>' \
--data '
{
"merchantId": "156",
"name": "Example merchant",
"businessType": "Fintech",
"businessRegistrationId": "<string>",
"taxNumber": "<string>",
"directorName": "<string>",
"websiteUrl": "<string>",
"country": "CI",
"headquarterAddress": "<string>"
}
'import requests
url = "https://api.example.com/compliance/kyb"
payload = {
"merchantId": "156",
"name": "Example merchant",
"businessType": "Fintech",
"businessRegistrationId": "<string>",
"taxNumber": "<string>",
"directorName": "<string>",
"websiteUrl": "<string>",
"country": "CI",
"headquarterAddress": "<string>"
}
headers = {
"ApiKey": "<apikey>",
"MerchantId": "<merchantid>",
"Environment": "<environment>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
ApiKey: '<apikey>',
MerchantId: '<merchantid>',
Environment: '<environment>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
merchantId: '156',
name: 'Example merchant',
businessType: 'Fintech',
businessRegistrationId: '<string>',
taxNumber: '<string>',
directorName: '<string>',
websiteUrl: '<string>',
country: 'CI',
headquarterAddress: '<string>'
})
};
fetch('https://api.example.com/compliance/kyb', 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.example.com/compliance/kyb",
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([
'merchantId' => '156',
'name' => 'Example merchant',
'businessType' => 'Fintech',
'businessRegistrationId' => '<string>',
'taxNumber' => '<string>',
'directorName' => '<string>',
'websiteUrl' => '<string>',
'country' => 'CI',
'headquarterAddress' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"ApiKey: <apikey>",
"Content-Type: application/json",
"Environment: <environment>",
"MerchantId: <merchantid>"
],
]);
$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.example.com/compliance/kyb"
payload := strings.NewReader("{\n \"merchantId\": \"156\",\n \"name\": \"Example merchant\",\n \"businessType\": \"Fintech\",\n \"businessRegistrationId\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"directorName\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"country\": \"CI\",\n \"headquarterAddress\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ApiKey", "<apikey>")
req.Header.Add("MerchantId", "<merchantid>")
req.Header.Add("Environment", "<environment>")
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.example.com/compliance/kyb")
.header("ApiKey", "<apikey>")
.header("MerchantId", "<merchantid>")
.header("Environment", "<environment>")
.header("Content-Type", "application/json")
.body("{\n \"merchantId\": \"156\",\n \"name\": \"Example merchant\",\n \"businessType\": \"Fintech\",\n \"businessRegistrationId\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"directorName\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"country\": \"CI\",\n \"headquarterAddress\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/compliance/kyb")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"merchantId\": \"156\",\n \"name\": \"Example merchant\",\n \"businessType\": \"Fintech\",\n \"businessRegistrationId\": \"<string>\",\n \"taxNumber\": \"<string>\",\n \"directorName\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"country\": \"CI\",\n \"headquarterAddress\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"merchantId": "156",
"name": "Example merchant",
"businessType": "Fintech",
"businessRegistrationId": "<string>",
"taxNumber": "<string>",
"directorName": "<string>",
"websiteUrl": "<string>",
"country": "CI",
"headquarterAddress": "<string>",
"id": 1,
"createdAt": "2020-10-15T12:09:49.355Z",
"deletedAt": null
}{
"status": 400,
"error": {
"statusCode": 400,
"message": [
"destination.provider must be a string"
],
"error": "Bad Request"
}
}{
"status": 401,
"error": {
"type": "authorization_error",
"code": "wrong_credentials",
"message": "L'ID marchand et/ou la clé d'API sont incorrects."
}
}{
"httpStatus": 409,
"type": "invalid_request",
"code": "unsupported_action",
"message": "This action is not supported"
}{
"type": "internal_error",
"code": [
"internal_error",
"wrong_credentials",
"not_granted",
"live_mode_not_granted",
"merchant_inactive"
],
"message": "An error occurred on our system. Please try again later."
}Headers
Body
application/json
Response
Datetime in UTC timezone at which this object was created. Follows the Datetime ISO.
Example:
"2020-10-15T12:09:49.355Z"
Datetime in UTC timezone at which this object was deleted. Follows the Datetime ISO. Can be null.
Example:
null
