Review and decide on entity data submission

PATCH

/entity-data/{id}

Approve or reject a pending entity data submission. Only identity users with the can_review_entity_data permission (or * wildcard) on the entity can review its data. After a decision is made, the entity's kyc_status is recalculated based on whether all required fields are now approved. Entity data records can only be reviewed once — attempting to review an already-decided record will fail.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Entity data was reviewed successfully. The record status is updated to reflect the decision, and the entity's kyc_status is recalculated.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠422

Request Example

Shell

JavaScript

Java

Swift

cURL

Approve without providing a reasonApprove with an explanatory reasonReject with explanation of required corrections

curl --location --request PATCH '/entity-data/01HQZR2BKPFQ8MXJVT3G7LWNE' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "decision": "approved"
}'

Response Example

200 - Success

{
    "message": "Entity data reviewed successfully",
    "status": "success",
    "data": {
        "id": "01HQZR2BKPFQ8MXJVT3G7LWNE",
        "entity_id": "01HQZR2BKPFQ8MXJVT3G7LWNA",
        "field_name": "business_registration",
        "status": "approved",
        "status_reason": "Business registration certificate is valid and current",
        "kyc_status": "in_review"
    }
}

Modified at 2026-09-23 15:44:30

List entity data

Proxy a DELETE request to the Verification API