Skip to main content

Identity

This is an object for verification via several services. The request for a verification will first check if there is sufficient balance in your account and if successful, an order will be placed. The response will show that the request is in sync. A callback url is required so as to receive the final status of the verification. You could also check the status of the request using the status object.

POST: /v1/b2b/verify

Services​

  • kyc

Request​

    curl -X POST \
     https://api.tupay.africa:8888/v1/b2b/verify/{service} \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer {token}' \
     -H 'Idempotency-Key: {key}' \
     -d '"{"documentType": "{type}", "documentNumber": "{number}", "countryCode": {countryCode}, "firstName": {firstName}, "lastName": {lastName}, "dateOfBirth": {dateOfBirth}}"'
Identity Request
{
    "documentType": "ID",
    "documentNumber": "1234",
    "countryCode": "KE",
    "firstName": "John",
    "lastName": "Maina",
    "dateOfBirth": "2000-01-01",
    "reference": "ref1234"
}
  • documentType (String): The document type e.g. ID / PASSPORT / ALIENID
  • documentNumber (String): The document number
  • countryCode (String): The country code e.g. KE / RW (Kenya, Rwanda)
  • firstName (String): The first name
  • lastName (String): The last name
  • dateOfBirth (String): The date of birth (format yyyy-MM-dd)
  • reference (String): Your unique id *optional

Response​

Identity Response
{
    "id": "ABCDEFG250101",
    "reference": "ref1234",
    "status": 20,
    "mesasge": "Pending"
}
  • id (String): The transaction id (Optional incase of failure)
  • reference (String): Your unique id
  • status (Integer): The status of the request
  • message (String): The response message

Callback​

These are parameter that are included together with callback parameters (see callback next).

  • identity.documentType (String): The document type
  • identity.documentNumber (String): The document number
  • identity.documentSerialNumber (String): The document serial number
  • identity.documentIssueDate (String): The document issue date
  • identity.IssuedBy (String): The document issuing authority
  • identity.customer.firstName (String): The first name
  • identity.customer.middleName (String): The middle name
  • identity.customer.lastName (String): The last name
  • identity.customer.gender (String): The gender
  • identity.customer.nationality (String): The nationality
  • identity.customer.birthDate (String): The date of birth