Callbacks (Webhook Responses)

This is the Callbacks (Webhook Responses) page

Get Callbacks

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

Headers

Name	Type	Description
Content-type*	String	application/json

Request Body

Name	Type	Description
curl --location --request OPTIONS	String	follows HTTP redirects and specifically sends an HTTP OPTIONS request.

Init

{
  "status": "init",
  "event": "applicantCreated",
  "order": "6687e2a3d49fe128f868203f",
  "timestamp": "2024-07-05T12:10:20.741Z",
  "kyc_token": "",
  "account": "6687e2a3d49fe128f868203d",
  "user_reference": "914a7ba2-fba8-44b7-a30c-9b332b4ce630",
  "meta_data": {
    "kyc_note": "The user is being created and KYC process is initiated.",
    "kyc_status": "awaiting_approval"
  },
  "first_name": "",
  "last_name": "",
  "phone": "",
  "email": "",
  "country": ""
}

Started

{
  "status": "init",
  "event": "applicantPersonalInfoChanged",
  "order": "6687e2a3d49fe128f868203f",
  "timestamp": "2024-07-05T12:10:20.741Z",
  "kyc_token": "",
  "account": "6687e2a3d49fe128f868203d",
  "user_reference": "914a7ba2-fba8-44b7-a30c-9b332b4ce630",
  "meta_data": {
    "kyc_note": "The user is being created and KYC process is initiated.",
    "kyc_status": "awaiting_approval"
  },
  "first_name": "",
  "last_name": "",
  "phone": "",
  "email": "",
  "country": ""
}

Pending

{
  "status": "pending",
  "event": "applicantPending",
  "order": "66881ff8884ff64fd2af95e6",
  "timestamp": "2024-07-05T16:55:45.240Z",
  "kyc_token": "",
  "account": "66881ff8884ff64fd2af95e4",
  "user_reference": "flw-app-001",
  "meta_data": {
    "kyc_note": "A user has uploaded the required documents and their status changed to Pending.",
    "kyc_status": "awaiting_approval"
  },
  "first_name": "",
  "last_name": "",
  "phone": "",
  "email": "",
  "country": ""
}

Completed

{
  "status": "completed",
  "event": "applicantReviewed",
  "order": "66881ff8884ff64fd2af95e6",
  "timestamp": "2024-07-05T16:56:15.191Z",
  "kyc_token": "",
  "account": "66881ff8884ff64fd2af95e4",
  "user_reference": "flw-app-001",
  "meta_data": {
    "kyc_note": "Verification is complete.",
    "kyc_status": "approved"
  },
  "first_name": "",
  "last_name": "",
  "phone": "",
  "email": "",
  "country": ""
}

User Data

{
  "status": "completed",
  "event": "applicantReviewed",
  "order": "66881ff8884ff64fd2af95e6",
  "timestamp": "2024-07-05T16:56:22.889Z",
  "kyc_token": "",
  "account": "66881ff8884ff64fd2af95e4",
  "user_reference": "flw-app-001",
  "meta_data": {
    "kyc_note": "Verification is complete and user's data is being returned",
    "kyc_status": "approved"
  },
  "first_name": "Timilehin",
  "last_name": "Abodunrin",
  "phone": "[phone]",
  "email": "[e-mail]",
  "country": "NGA"
}

Key	Type	Description	Value
Status	String	refers to the current phase of an order.	initialized, started, pending or completed
Event	String	events are key actions in the KYC process, such as submission, review, or approval, that affect the order's progress and outcome.	submission, review, or approval
Order	String	It is a unique identifier assigned to a specific KYC order
Timestamp	String	It is a record of the date and time when a specific event occurred
Kyc_token	String	It is a unique token used to authenticate KYC processes
Account	String	It is used to uniquely reference and manage an individual's or entity's KYC profile within the system
User_reference	String	It is a unique identifier assigned to a user specifically to managae KYC processes.
Mega_data	Array	metadata helps in tracking, managing, and providing context to the KYC process.	KYC Note, KYC Status
First_name	String	This is the first name of the customer
Last_name	String	This is the last name of the customer
Phone	String	This is the customer's phone number
Email	String	This is the Customer's Email Address
Country	String	This is the customer's country