Get kyc information

curl --request GET \
  --url https://api.example.com/compliance/kyc \
  --header 'ApiKey: <apikey>' \
  --header 'Environment: <environment>' \
  --header 'MerchantId: <merchantid>'

import requests

url = "https://api.example.com/compliance/kyc"

headers = {
    "ApiKey": "<apikey>",
    "MerchantId": "<merchantid>",
    "Environment": "<environment>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {ApiKey: '<apikey>', MerchantId: '<merchantid>', Environment: '<environment>'}
};

fetch('https://api.example.com/compliance/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.example.com/compliance/kyc",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "ApiKey: <apikey>",
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/compliance/kyc"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("ApiKey", "<apikey>")
	req.Header.Add("MerchantId", "<merchantid>")
	req.Header.Add("Environment", "<environment>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/compliance/kyc")
  .header("ApiKey", "<apikey>")
  .header("MerchantId", "<merchantid>")
  .header("Environment", "<environment>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/compliance/kyc")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'

response = http.request(request)
puts response.read_body

{}

{
  "status": 401,
  "error": {
    "type": "authorization_error",
    "code": "wrong_credentials",
    "message": "L'ID marchand et/ou la clé d'API sont incorrects."
  }
}

{
  "type": "internal_error",
  "code": [
    "internal_error",
    "wrong_credentials",
    "not_granted",
    "live_mode_not_granted",
    "invalid_sandbox_msisdn",
    "invalid_url",
    "orange_invalid_url",
    "wrong_provider",
    "override_business_name",
    "do_not_override_business_name"
  ],
  "message": "An error occurred on our system. Please try again later."
}

{
  "status": 501,
  "error": "Method not implemented"
}

GET

compliance

kyc

Get kyc information

curl --request GET \
  --url https://api.example.com/compliance/kyc \
  --header 'ApiKey: <apikey>' \
  --header 'Environment: <environment>' \
  --header 'MerchantId: <merchantid>'

import requests

url = "https://api.example.com/compliance/kyc"

headers = {
    "ApiKey": "<apikey>",
    "MerchantId": "<merchantid>",
    "Environment": "<environment>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {ApiKey: '<apikey>', MerchantId: '<merchantid>', Environment: '<environment>'}
};

fetch('https://api.example.com/compliance/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.example.com/compliance/kyc",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "ApiKey: <apikey>",
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/compliance/kyc"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("ApiKey", "<apikey>")
	req.Header.Add("MerchantId", "<merchantid>")
	req.Header.Add("Environment", "<environment>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/compliance/kyc")
  .header("ApiKey", "<apikey>")
  .header("MerchantId", "<merchantid>")
  .header("Environment", "<environment>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/compliance/kyc")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["ApiKey"] = '<apikey>'
request["MerchantId"] = '<merchantid>'
request["Environment"] = '<environment>'

response = http.request(request)
puts response.read_body

{}

{
  "status": 401,
  "error": {
    "type": "authorization_error",
    "code": "wrong_credentials",
    "message": "L'ID marchand et/ou la clé d'API sont incorrects."
  }
}

{
  "type": "internal_error",
  "code": [
    "internal_error",
    "wrong_credentials",
    "not_granted",
    "live_mode_not_granted",
    "invalid_sandbox_msisdn",
    "invalid_url",
    "orange_invalid_url",
    "wrong_provider",
    "override_business_name",
    "do_not_override_business_name"
  ],
  "message": "An error occurred on our system. Please try again later."
}

{
  "status": 501,
  "error": "Method not implemented"
}

Headers

ApiKey

string

required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantId

string

required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment

enum<string>

required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Available options:

live,

sandbox

Path Parameters

Query Parameters

transactionType

string

required

The type of the transaction

Example:

"transfer"

provider

string

required

The name of the destination provider

Example:

"orange"

country

string

required

The country of the transaction

Example:

"CI"

method

string

required

The destination type

Example:

"mobile money"

identifier

string

required

The identifier of the destination, mobile number or bank account number

Example:

"+22500000001"

Response

The response is of type object.

Data

Balance

Webhooks

Sms

Payments

Provisioning

Receipt

Payment on Terminal

IRT

Transfers

Refunds

Compliance

Recipients

Processing Only

Payment Links

Submerchants

Get kyc information

Headers

Path Parameters

Query Parameters

Response