v1

latestOpenAPI 3.0.02026-07-265892227.1 KB
Compliance

Get kyc information

get/compliance/kyc

Path parameters

{"stackTrail":"paths:/compliance/kyc:get:parameters:5:schema","oasType":"schema","type":"unknown"}

Reference of the kyb transaction to retrieve.

Query parameters

transactionTypestring required
Example:transfer

The type of the transaction

providerstring required
Example:orange

The name of the destination provider

countrystring required
Example:CI

The country of the transaction

methodstring required
Example:mobile money

The destination type

identifierstring required
Example:+22500000001

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

Headers

ApiKeystring 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.

MerchantIdstring 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'live' | 'sandbox' required

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

Response

KycInformation required