API Reference

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

post
https://example.com/programs//kycGates/scanCapture

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

Path Params
string
required

The unique code identifying the partner program context.

Body Params

The Gd.Bos.DataTransfer.Request.CreateScanCaptureRequest object containing ID images and product code.

string | null

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.

string | null

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.

encryptedIdentityDocumentation
object

Represents a container for encrypted data used in secure data transfer operations. Contains the encrypted payload and associated cryptographic metadata, including encryption version, ephemeral public key, and public key hash. Used to securely transmit sensitive information such as user data, ensuring confidentiality and integrity during transport.

Headers
string
required

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago