> For the complete documentation index, see [llms.txt](https://docs.faceki.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.faceki.com/data-fields/verification-data/ekyc-webhook-structure.md).

# EKYC Webhook Structure

When the EKYC (Electronic Know Your Customer) process is completed, a webhook will be triggered with the results. The EKYC Webhook Response contains critical information about the status of the KYC request, as well as the user details involved.

####

```json
{
    "requestId": "973f1bb2-c4a6-424c-ae61-d220202b0611",  
    "fullName": "JOHN",                 
    "status": "ACCEPTED",                                  
    "kycData": {}
}

```

#### Response Fields

* **requestId**: A unique identifier for the specific KYC request. This ID can be used for tracking, logging, and troubleshooting.
* **fullName**: The full name of the person undergoing the KYC verification.
* **status**: Indicates the result of the KYC verification. Common values are:
  * `ACCEPTED`: The KYC process was successful.
  * `DECLINED`: The KYC process failed.
  * `REVIEW`: The KYC process need manual review.
* **kycData**: This section will contain detailed information about the verified individual, including identity information, documents, and other relevant KYC data. For the full structure of `kycData`, refer to the detailed KYC data structure [Link](/data-fields/verification-data.md).

## EKYC Update from Portal Webhook Response

The **EKYC Update from Portal** webhook is triggered when there is an update to the KYC status on the portal. This response contains updated information, including the new status of the KYC verification and details about the modification.

```json
{
    "requestId": "da870610-2311-42c7-9d8b-85accb14b399",     // Unique identifier for the KYC request
    "fullName": "JOHN",              // Full name of the individual
    "status": "DECLINED",                                     // Updated status of the KYC verification (DECLINED/APPROVED)
    "modifiedByEmail": "example@example.com"             // Email address of the user who made the update
}

```

#### Response Fields

* **requestId**: A unique identifier for the KYC request. This ID is used to track and correlate the update.
* **fullName**: The full name of the individual whose KYC verification status has been updated.
* **status**: The updated status of the KYC verification. The status could be:
  * `APPROVED`: The KYC process has been approved.
  * `DECLINED`: The KYC process has been declined.
  * `REVIEW`: The KYC status changed to review.
* **modifiedByEmail**: The email address of the user who made the update or modification to the KYC status. This helps identify who is responsible for the status change.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.faceki.com/data-fields/verification-data/ekyc-webhook-structure.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
