Get Verification Status and User's Data

GET https://fuspay-kyc-prod-e9eb4fd3aa33.herokuapp.com/api/v1/order/verification-status

This endpoint is used to know the KYC status of your user. Where they are in the KYC Journey.

Request Header

Name	Type	Description
Content-type*	String	application/json

Query Parameter

Name	Description
app_id	This is your app's ID
user_reference	This is your user's reference from your system

Response Body

{
  "status": "UNPROCESSED",
  "user_facial_images": {
    "image_1": "",
    "image_2": ""
  },
  "_id": "6687e6b301dd50bc5e48af12",
  "email": "[email protected]",
  "full_name": "Ndoh Joel",
  "phone": "08113372866",
  "app": "667884fafdd3466dbf7c5fa4",
  "kyc_type": "6675bf35dbeea1617aaad262",
  "scan_ref": "",
  "verification_url": "http://localhost:5173/verification/individual/6687e6b301dd50bc5e48af12",
  "callback": "https://custom-webhook-app-8b6d54acde1c.herokuapp.com/api/payload",
  "reference": "cee4d97b-c90b-425f-a902-0883b4b142ca",
  "redirect": "",
  "address": "",
  "bvn": "",
  "country": "",
  "govt_id_no": "",
  "govt_id_photo": "",
  "proof_of_address": "",
  "bank_statement": "",
  "user_indemnity": "",
  "guarantors_form": "",
  "id_of_guarantor": "",
  "guarantors_proof_of_address": "",
  "created_at": "2024-07-05T12:27:31.958Z",
  "updated_at": "2024-07-05T12:27:31.971Z",
  "__v": 0,
  "order": {
    "_id": "6687e6b301dd50bc5e48af14",
    "progress": [],
    "error": [],
    "status": "UNPROCESSED",
    "kyc_token": "",
    "created_at": "2024-07-05T12:27:31.966Z",
    "updated_at": "2024-07-05T12:27:31.966Z",
    "__v": 0
  }
}

Response Body Description

Key	Type	Description	Value
status	String	refers to the current state of the KYC process for an individual or business	UNPROCESSED
user's_facial_images	Array	These are the images of the user's face
_id	String	The identity number used to recognize and track the user in the verification process.
email	String	email of the user
full_name	String	full name of the user
phone	String	phone number of the user
app	String	This is your apps id
kyc_type	String	This is a string representing the KYC type. Each KYC type has an identifier
scan_ref	String	reference number or identifier that is associated with the verification process
verification_url	String	this is the link where your user is redirected to go and perform the KYC	http://localhost:5173/verification/individual/6687e6b301dd50bc5e48af12
callback	String	This is the URL where KYC status of your user would be posted after they have completed the KYC journey	https://custom-webhook-app-8b6d54acde1c.herokuapp.com/api/payload
reference	String	This is an identifier for your user from your end.	e.g. cee4d97b-c90b-425f-a902-0883b4b142ca
redirect	String	This is a URL where we would redirect your users after they have completed the KYC journey.
address	String	This is the house address of the user
bvn	String	This is the bank verification number of the user
country	String	This is the user's country
govt_id_no	String	This is the government identity number of the user
govt_id_photo	String	This is the user's government id photo
proof_of_address	String	This is the user's proof of address
bank_statement	String	This is the bank statement of the user
user_indemnity	String	This is the user's agreement to cover losses or liabilities from their actions. 4o
guarantors_form	String	This is the document where guarantors agree to cover obligations if the primary party defaults
id_of_guarantor	String	This is the id of the guarantor
guarantors_proof_of_address	String	This is the guarantors proof of address
created_at	Datetime	this is the time your app was registered on the KYC system	e.g. 2024-07-05T12:27:31.958Z
updated_at	Datetime	This is the last time a value was updated on your app's data	e.g. 2024-07-05T12:27:31.971Z
__v	Number
order	Array	A request to initiate the verification process or to check the status of a user's data.