Create KYC Request

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

Create Order Endpoint for Individual

POST https://fuspay-kyc-prod-e9eb4fd3aa33.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.

Sample body

{
    "full_name": "Emmanuel Balogun",
    "email": "hacooack07@gmail.com",
    "phone": "09000000140",
    "app": "670fb4c4cef28414ab5",
    "kyc_type":"Individual",
    "callback":"https://webhook.site/1aaef360-7f89-48d9-a0ab-5848c5be538e",
    "Redirect":"https://webhook.site/1aaef360-7f89-48d9-a0ab-5848c5be538e",
    "reference": "10000123"
}
{
  "_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
}

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.

Last updated