Know Your Customer (KYC)

The process for managing a users' KYC Status.

KYC Level dictates what services your App users can access and to what extent. Increasing the KYC level of the user will enable them to access more services and limits. The user must provide more details about themselves to ‘KYC level up’.

By default, user accounts are set to KYC L0. When it is time to KYC level up, the personal details already harvested will be processed and analyzed against various Anti Money Laundering (AML), fraud, and sanctions lists to make sure the customer is not a known fraudster. It is important that the users' real data is provided at this stage. Not nicknames or aliases, etc. When they wish to use L1 services we will ask them to provide a copy of their national ID/Passport and a selfie.

/kyc/case/query

Requests the current KYC-related user information.

• 'KYC Level' relates to the KYC level that the customer's account is currently set to. The possible values are L0, L1.

• ‘KYC Status’ indicates whether any KYC activity is required or not. The possible values are as follows:

  • Failed → Upgrade Failed

  • Processing → The KYC platform is processing your request. Please check again in a few minutes.

  • OK → No action is currently required

/kyc/case/query

POST https://sandbox.walletengine.io/api/kyc/case/query

Use this API to find out the current KYC status of a customer.

Headers

Name	Type	Description
Authorization	string	Bearer {{token}}
Content-Type	string	application/json

Request Body

Name	Type	Description
app_id	string	This is the unique App ID assigned to you by Wallet Engine.

200 Successfully.

{
  "kyc_level": "1",
  "kyc_status": "OK"
}

500 The method was called with invalid arguments.

{
    "code": 500,
    "error": "invalid_arguments",
    "message": "The method was called with invalid arguments."
}

Example Request

{
  "app_id": "5db2a50be7626"
}

Errors This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Error	Description
fatal_error	The server could not complete your operation(s) without encountering a catastrophic error.
invalid_arguments	The method was called with invalid arguments.

/kyc/send-invitation

POST https://sandbox.walletengine.io/api/kyc/send-invitation

Use this API to send an invitation with a magic link to the customer email who would like to upgrade KYC from L0 to L1.

Headers

Name	Type	Description
Authorization	string	Bearer {{token}}
Content-Type	string	application/json

Request Body

Name	Type	Description
app_id	string	This is the unique App ID assigned to you by Wallet Engine.

200 Successfully.

{
    "valid": true
}

500 Some arguments are invalid.

{
    "error": "invalid_arguments",
    "message": "The method was called with invalid arguments."
}

Example Request

{
  "app_id":"5db2a50be7626"
}

Errors This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing.

Error	Description
invalid_arguments	The method was called with invalid arguments.
fatal_error	The server could not complete your operation(s) without encountering a catastrophic error.