KYC (Business)

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 know the KYC status of your user. Where they are in the KYC Journey.

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.
flow_id	String	The flow id irepresents 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

Create a KYC request for a Business

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

Name	Type	Description
Content-Type*	String	application/json

Request Body

{
    "business_name": "Springbok 9",
    "country": "Nigeria",
    "business_email": "[e-mail]",
    "app": "{{kyc_app_id}}",
    "kyc_type": "{{kyc_type_id}}",
    "callback": "https://webhook.site/29e10900-6a6d-4663-b2d9-def37b0768d9",
    "reference": "1234",
    "redirect": "https://webhook.site/29e10900-6a6d-4663-b2d9-def37b0768d9",
    "custom_files": ["Birth Certificate", "NIN"],
    "state_of_jurisdiction": "Indonesia"
}

Key	Type	Description
business_name	String	The name of the business to be KYCed
country	String	The country of the business of be KYCed
business_email	String	This is the email of the business you are trying to do KYC for
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.
custom_files	Array	This is an array containing a list of extra/custom files you would like to be collected from the business
state_of_jurisdiction	String	This is the country the business was incorporated in.

200: OK successful response

{
  "_id": "65dfee0ee6198e7a89765cfa",
  "app": "65cc972b458f23f853670917",
  "business_name": "Fuspay Technologies",
  "country": "Nigeria",
  "business_email": "[e-mail]",
  "kyc_type": {
    "_id": "65de68871f07994754c3db87",
    "name": "Business",
    "created_at": "2024-02-27T22:56:07.010Z",
    "updated_at": "2024-02-27T22:56:07.010Z",
    "__v": 0
  },
  "verification_url": "http://localhost:5173/verification/business/65dfee0ee6198e7a89765cfa",
  "reference": "1234",
  "redirect": "https://webhook.site/29e10900-6a6d-4663-b2d9-def37b0768d9",
  "custom_files": [],
  "created_at": "2024-02-29T02:38:06.033Z",
  "updated_at": "2024-02-29T02:38:06.052Z",
  "__v": 0,
  "order": {
    "_id": "65dfee0ee6198e7a89765cfc",
    "progress": [],
    "error": [],
    "status": "Unprocessed",
    "kyc_token": "",
    "created_at": "2024-02-29T02:38:06.047Z",
    "updated_at": "2024-02-29T02:38:06.063Z",
    "__v": 0
  }
}

400: Bad Request failed responses

Response Body

Key	Type	Description	Value
_id	String	id representing the business that has been KYCed on the KCY system
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 eg individual or businesses
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.
custom_files	Array	an Array containing the custom files to be collected from the business
order	Object	This is an object containing details of the KYC request/order
_id	String	this is an id presenting the KYC request itself
status	String	This is the status of the order e.g
status	String	The status of the order

Verify User KYC Status

GET https://fuspay-kyc-ms-df741b092e53.herokuapp.com/api/v1/order/app/:app_id/user_reference/:reference/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
app_id	This is your app's ID
reference	This is your user's reference from your system

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