KYC overview
Use the KYC API to start customer verification, upload supporting documents, and retrieve verification documents or status.
Start a KYC session or browse the operations in this category.
Review the recommended verification flow before integrating.
Verification flows
Gravv supports two verification flows:
- Hosted flow — call
POST /v1/customers/kyc/start. The customer completes verification through the provider's hosted experience. This is the simplest integration. - Server-to-server (S2S) flow — you collect and submit documents yourself:
- Upload each required document as a base64-encoded string with its metadata.
- Start S2S verification once all required documents are uploaded.
In both flows, poll GET /v1/customers/{customer_id}/kyc/status for the outcome, or subscribe to customer KYC webhook events.
For business customers, complete KYC verification for every associated person before starting the business's own verification.
Endpoints
| Endpoint | Description |
|---|---|
POST /v1/customers/kyc/start |
Start hosted KYC verification for a customer |
POST /v1/customers/kyc/upload-document |
Upload a base64-encoded KYC document (S2S step 1) |
POST /v1/customers/kyc/start-s2s |
Start server-to-server verification using uploaded documents (S2S step 2) |
GET /v1/customers/{customer_id}/kyc/documents |
List a customer's uploaded documents with metadata |
GET /v1/customers/{customer_id}/kyc/status |
Current verification status and review result |
Reading verification status
| Field | While in review | After review |
|---|---|---|
reviewStatus |
pending |
completed |
reviewResult |
omitted | contains the decision |
Authentication
All requests use https://api.gravv.xyz/v1/ and authenticate with the Api-Key header. See Authentication for details.
Was this page helpful?