HUhub2
Compliance

Get kyc information

Changed on
get/compliance/kyc

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: ApiKey, MerchantId, Environment

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

method'mobile_money' | 'bank_transfer' | 'airtime' 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

isActiveboolean required

Whether the kyc information is active

firstNamestring required

The first name attached to the identifier

lastNamestring required

The last name attached to the identifier

Example response

{
  "isActive": true,
  "firstName": "Aminata",
  "lastName": "Traoré",
  "data": {
    "valid": true,
    "mno": "orange",
    "country": "CI",
    "country_code": "CI",
    "country_name": "Ivory Coast"
  }
}

Changes

  • f6d3f87df5e0Revision changes
    • breaking

      the query request parameter method was restricted to a list of enum values

    • warning

      deleted the path request parameter reference

    • info

      added the new enum value airtime to the query request parameter method

    • info

      added the new enum value bank_transfer to the query request parameter method

    • info

      added the new enum value mobile_money to the query request parameter method

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status