GET
/
compliance
/
kyc
{}

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

​
reference
any
required

Reference of the kyb transaction to retrieve.

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

200
application/json

The response is of type object.