Digital Onboarding Documentation
  • Introduction
    • Obtaining The API Key
  • API Reference
    • Document Upload Error Responses
    • Uploading Face Image
    • Face Image Error Responses
    • Liveliness Verification
    • Liveliness Error Responses
    • Creating an eKYC Request
    • Accepting eKYC Request
    • Retrieving eKYC Request
    • Retrieving Single eKYC Request
    • Clearing eKYC Request
    • Deleting eKYC Request
Powered by GitBook
On this page
  1. API Reference

Deleting eKYC Request

A function to drop the requests and registered user in the dashboard

Warning: This request will clear all eKYC requests stored within the developer's API key. This function is not to be used to deny registration of a user applying into the institution.

Request Endpoint: /api/delete-request Request Type: DELETE

Header:

{
    "Content-Type": "application/json",
    "Accept": "application/json",
    "x-api-key": "Your API key"
}

x-api-key: The API key you obtained upon signing up for the Lapis eKYC dashboard.

Body:

{"id":"Returned ID response"}

id: The request ID you want to delete

Successful Response: Upon successfully deleting KYC request, the API response will resemble the following structure:

Response status: 200

{
    "message": "KYC request deleted!"
}

Error Responses:

  • If the provided API key is invalid, the following error message will be returned. Please ensure that the API key you provide is correct and valid.

Response status: 401

{
    "error": "invalid api key"
}
PreviousClearing eKYC Request

Last updated 1 year ago