Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Kyc

Generate DocV Document Request – Returns a DocVTransaction Token for Socure DocV SDK initialization.

Returns a DocVTransaction Token for Socure DocV SDK initialization and an optional upload URL for user identity documents.

post/programs/{programCode}/accounts/{accountIdentifier}/users/{userIdentifier}/socureDocumentRequest

Path parameters

programCodestring required

The unique code identifying the partner program context.

accountIdentifierstring required

The unique identifier of the account associated with the user.

userIdentifierstring required

The unique identifier of the user for whom the document request is generated.

Headers

X-GD-RequestIdstring required

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

X-GD-ApiVersionstring

The api Version header. Optional. Pass the value V2 if required in integration.

Response

Accepted

referenceIdstring nullable

The unique reference identifier for the document request. Used to track and correlate the document upload and verification process.

documentUploadUrlstring nullable

The URL to which the user’s identity document should be uploaded. Used by partners to submit document images for verification.

docVTransactionTokenstring nullable

The DocVTransaction token generated for the document verification session. Used to initialize the Socure DocV SDK and link the uploaded document to the verification flow.