KYC (Individual)

These endpoints are used to manage KYC for an individual

Get KYC Types

GET https://fuspay-kyc-ms-df741b092e53.herokuapp.com/api/v1/kyc_type

This endpoint is used to get an Array of KYC types (Business, Individual). This provided the _id of the KYC that would be used when creating a KYC request

Response

200

[
  {
    "_id": "6564dc907049168cd3eeab8e",
    "flow_id": "6551e7065c98f8001cee0fc2",
    "name": "Business",
    "created_at": "2023-11-27T18:14:40.904Z",
    "updated_at": "2023-11-27T18:14:40.904Z",
    "__v": 0
  }
]

Key	Type	Description
_id	String	This is the id that represents the KYC (Business, Individual) .
flow_id	String	The flow id represents the specific flow of the KYC. Eg KYC for individuals can have different flows
name	String	This describes the kind of KYC e.g. Business.

Create KYC Request

This endpoint is used to create a KYC request for an individual

POST https://fuspay-kyc-ms-df741b092e53.herokuapp.com/api/v1/order/

Headers

Name	Type	Description
Content-Type*	String	application/json

Request Body

Key	Type	Description
full_name	String	The user full name to create the KYC
email	String	The user email to create the KYC
phone	String	The phone number to create the KYC
app	String	This is your app's ID
kyc_type	String	This is a string representing the KYC type. Each KYC type has an identifier
callback	String	A webhook where notifications from us would be posted to
redirect	String	This is a URL where we would redirect your users after they have completed the KYC journey.
reference	String	This is an identifier for your user from your end.

200: OK successful response

{
  "_id": "660c1000ed806b0874954140",
  "app": "66053d262d3f43787be1e1a6",
  "kyc_type": {
    "_id": "65cc97ef7aef3a4c06747dfe",
    "name": "Individual",
    "created_at": "2024-02-14T10:37:35.637Z",
    "updated_at": "2024-02-14T10:37:35.637Z",
    "__v": 0
  },
  "scan_ref": "",
  "verification_url": "http://localhost:5173/verification/individual/660c1000ed806b0874954140",
  "callback": "https://custom-webhook-app-8b6d54acde1c.herokuapp.com/api/payload",
  "reference": "1234",
  "redirect": "https://custom-webhook-app-8b6d54acde1c.herokuapp.com",
  "created_at": "2024-04-02T14:02:40.628Z",
  "updated_at": "2024-04-02T14:02:40.640Z",
  "__v": 0
}

400: Bad Request failed responses

Response Body

Key	Type	Description	Value
_id	String	This is the identifier representing the request sent to the KYC create request endpoint
app	String	This is your app's ID
kyc_type	Object	An object containing info about the KYC performed
_id	String	the id of the KYC type
name	String	the type of KYC that was performed.	Individual/Business
verification_url	String	this is the link where your user is redirected to go and perform the KYC
callback	String	This is the URL where KYC status of your user would be posted after they have completed the KYC journey
redirect	String	This is the URL where your user would be redirected after KYC.

Verify User KYC Status

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.

Headers

Query Params

Name	Description
email	The email you used in creating your KYC
reference	The reference you used in creating your KYC

Response

200

{
  "status": "UNPROCESSED"
}

400

{
  "error": "Invalid request"
}

Key	Type	Description	Value
Status	String	refers to the current state of the KYC process for an individual or business	UNPROCESSED