GRgreendot
Kyc

Add ScanCapture Request – Submits Matricula Consular ID images for verification.

Submits Matricula Consular ID images for verification. Returns onboarding ID and verification status.

post/programs/{programCode}/kycGates/scanCapture

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The unique code identifying the partner program context.

Headers

X-GD-RequestIdstring required

The unique request identifier (GUID) for tracking and idempotency. Required in the X-GD-RequestId header.

Request body

channelstring nullable

The channel through which the scan capture request was initiated (e.g., "Web", "Mobile"). Used to identify the source platform or integration for the request.

productCodestring nullable

The product code associated with the scan capture request (e.g., "CARD", "SAVINGS"). Used to scope the scan capture and verification to a specific product or service.

Response

Accepted

Changes

No recorded changes to this operation across all 2 revisions of this API.