CorebanqCorebanq Developer Docs
Kycv1Identity Verification

Initiate Signatory IDV

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

POST/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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "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",
  "verification_url": "http://example.com",
  "expires_at": "2019-08-24T14:15:22Z"
}
{
  "status": 400,
  "message": "Invalid request parameters"
}
{
  "status": 401,
  "message": "Authentication required"
}
{
  "status": 403,
  "message": "Insufficient permissions"
}
{
  "status": 404,
  "message": "Screening record not found"
}
{
  "status": 409,
  "message": "Identity verification already in progress"
}
{
  "status": 500,
  "message": "Internal server error"
}