Verify KYC

Retrieves the current verification status of a KYC verification previously initiated through the Create KYC endpoint. The verification_id obtained from the Create KYC response is used to identify the KYC verification to be checked.

Request

Method: GET

Endpoint:

{{base_url}}/api/v1/kyc/verify/{verification_id}

Path Parameters

Parameter	Type	Required	Description
`verification_id`	String	Yes	The unique verification ID returned when the KYC verification was created.

Authentication & Headers

Header	Type	Required	Description
`Authorization`	String	Yes	`Bearer ${api_key}` — your activated merchant API key.
`x-merchant-ref`	String	Yes	Your unique merchant reference.

Request Body

This endpoint does not require a request body.

Response

Success Response

{
  "status": "success",
  "message": "Kyc status fetched",
  "data": {
    "status": "approved",
    "user": {
      "id": "6a69d92f664f47dc13cb12f5",
      "user_ref": "LGB_000000000001",
      "email": "[email protected]",
      "phone": "2348064642044",
      "first_name": "Charles ",
      "middle_name": "Avis",
      "last_name": "Ayodeji",
      "dob": "1990-08-01"
    }
  }
}

Response Fields

Field	Type	Description
`status`	String	Indicates whether the request was successful.
`message`	String	Response message.
`data`	Object	Contains the KYC verification result.
`data.status`	String	Current status of the KYC verification.
`data.user`	Object	Contains the details of the user associated with the verification.
`user.id`	String	Unique identifier of the user.
`user.user_ref`	String	Unique reference assigned to the user.
`user.email`	String	User's email address.
`user.phone`	String	User's phone number.
`user.first_name`	String	User's first name.
`user.middle_name`	String	User's middle name.
`user.last_name`	String	User's last name.
`user.dob`	String	User's date of birth.

Updated 27 days ago

Did this page help you?