Gravv DOCS
Docs Agent Get Started
API Reference Get applicant verification status

Get applicant verification status

Retrieves the current KYC review status for a customer from the verification provider.

Use this endpoint to check a customer's verification outcome after you initiate KYC. While a review is in progress, reviewStatus is pending and reviewResult is omitted. Once the review finishes, reviewStatus is completed and reviewResult contains the decision.

GET/v1/customers/{customer_id}/kyc/status

Path Parameters

UUID of the customer

Responses

Status Description
200 Current verification status retrieved
400 Invalid request
404 Customer or applicant not found
500 Internal processing error while retrieving status

200 response

Overall review status from the verification provider. pending while a review is in progress; completed once a decision is returned.

Review outcome. Present once reviewStatus is completed; omitted while the review is pending.

Verification decision.

Possible values: approved, rejected

Reason codes for a rejection. Present only when reviewAnswer is rejected.

Rejection category, such as RETRY. Present only when reviewAnswer is rejected.

Timestamp of the review decision, in YYYY-MM-DD HH:MM:SS+0000 format. Omitted while reviewStatus is pending.

Applicant review priority.

Error information if the request failed

{
"data": {
"reviewStatus": "completed",
"reviewResult": {
  "reviewAnswer": "approved"
},
"reviewDate": "2026-06-19 21:59:00+0000",
"priority": 0
},
"error": null
}
{
"data": {
"reviewStatus": "completed",
"reviewResult": {
  "reviewAnswer": "rejected",
  "rejectLabels": [
    "BAD_SELFIE",
    "SCREENSHOTS",
    "UNSATISFACTORY_PHOTOS"
  ],
  "reviewRejectType": "RETRY"
},
"reviewDate": "2026-06-19 20:44:19+0000",
"priority": 0
},
"error": null
}
{
"data": {
"reviewStatus": "pending",
"priority": 0
},
"error": null
}

400 response

Always null for error responses

Human-readable error message

{
"data": null,
"error": {
"code": "INVALID_REQUEST",
"message": "The customer ID provided is not valid. Please verify the customer ID format."
}
}

404 response

Always null for error responses

Human-readable error message

{
"data": null,
"error": {
"code": "CUSTOMER_NOT_FOUND",
"message": "Customer not found. Please verify the customer exists in our system."
}
}
{
"data": null,
"error": {
"code": "KYC_NOT_FOUND",
"message": "no applicant found for customer; KYC has not been initiated"
}
}

500 response

Always null for error responses

Human-readable error message

{
"data": null,
"error": {
"code": "KYC_PROCESSING_ERROR",
"message": "failed to retrieve applicant status"
}
}

Authorization

  • ApiKeyAuth
Was this page helpful?
Assistant
Responses are generated using AI and may contain mistakes.

Ask me anything about the documentation.

ESC