CorebanqCorebanq Developer Docs
Kycv1Identity Verification

Get Signatory IDV Status

Returns the identity verification status. By default returns cached data. Use ?refresh=true to fetch fresh data from Ondato API. Active sessions (pending/in_progress) older than 5 minutes are automatically refreshed.

GET/v1/kyc/{customer_id}/signatories/{signatory_id}/idv

Authorization

bearerAuth
AuthorizationBearer <token>

JWT token obtained from authentication endpoint. Include the token in the Authorization header as 'Bearer {{user_token}}'

In: header

Path Parameters

customer_id*string

Customer identifier

signatory_id*string

Signatory identifier

Query Parameters

refresh?boolean

Force refresh from Ondato API instead of returning cached data

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/kyc/497f6eca-6276-4993-bfeb-53cbbbba6f08/signatories/497f6eca-6276-4993-bfeb-53cbbbba6f08/idv"
{
  "verification_id": "5bcbf7ac-c998-46ce-aa6e-a0c1a3f1f5bd",
  "session_id": "string",
  "status": "not_started",
  "provider": "string",
  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  "signatory_id": "9516df81-fc1b-44b5-9714-b62076b8800f",
  "verification_url": "http://example.com",
  "expires_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "response_data": {}
}
{
  "status": 401,
  "message": "Authentication required"
}
{
  "status": 403,
  "message": "Insufficient permissions"
}
{
  "status": 404,
  "message": "Screening record not found"
}
{
  "status": 500,
  "message": "Internal server error"
}

POSTInitiate Signatory IDV

Creates a new Ondato identity verification session for the specified signatory and returns a shareable URL.

POSTScreen Entity

Universal screening method with db-first check strategy. Checks database for existing results first, then performs new screening if needed. Use force=true to bypass cache and force new screening.