Endpoints for retrieving, checking status, and downloading identification evidence collected during Express QES signing. Requires Express QES identification evidence to be enabled for the business and a completed identification process.
Get Identification Evidence Status
Returns the current status of the identification evidence for the given
SignatureRequest and evidence_id.
Requirements:
- The business must have Express QES identification evidence enabled. If it is not,
the request fails with
403 Forbidden(problem typefeature-not-enabled). - The identification process must have been initiated (
evidence_idis required, available insigner_identity_data.evidence_idof theSignatureRequestresponse).
path Parameters
SR_IDUnique ID received when creating the Signature Request object
EVIDENCE_IDUnique ID of the identification evidence record, available in the signer_identity_data.evidence_id field of the SignatureRequest response once identification is complete.
Get Identification Evidence Status › Responses
OK
idInternal ID of the evidence record.
transactionCodeUnique transaction code for the identification process.
accountIdInternal account ID associated with the identification.
workflowIdInternal workflow ID used for the identification process.
statusCurrent status of the identification process.
Present if the identification is pending manual review, otherwise null.
createdAtTimestamp when the identification was created.
expiresAtTimestamp when the identification evidence expires.
startedAtTimestamp when the identification process was started by the signer.
Timestamp when the identification process was completed. Null if not yet completed.
Timestamp when the identification was reviewed. Null if not reviewed.
Get Identification Evidence JSON
Retrieves the full identification evidence record as JSON for the given
SignatureRequest and evidence_id.
Requirements:
- The business must have Express QES identification evidence enabled. If it is not,
the request fails with
403 Forbidden(problem typefeature-not-enabled). - The identification process must be completed (
evidence_idis required).
path Parameters
SR_IDUnique ID received when creating the Signature Request object
EVIDENCE_IDUnique ID of the identification evidence record, available in the signer_identity_data.evidence_id field of the SignatureRequest response once identification is complete.
Get Identification Evidence JSON › Responses
Identification result for the completed Express QES identification process. The exact schema depends on the identification provider configuration and is available on request.
Get Identification Evidence Files
Downloads all files related to the identification evidence as a ZIP archive.
Requirements:
- The business must have Express QES identification evidence enabled. If it is not,
the request fails with
403 Forbidden(problem typefeature-not-enabled). - The identification process must be completed (
evidence_idis required).
path Parameters
SR_IDUnique ID received when creating the Signature Request object
EVIDENCE_IDUnique ID of the identification evidence record, available in the signer_identity_data.evidence_id field of the SignatureRequest response once identification is complete.
Get Identification Evidence Files › Responses
OK — ZIP archive containing all identification evidence files.
Get Identification Evidence JWT
Retrieves the signed JWT for the identification evidence. Useful for cryptographic verification or downstream integration purposes.
Requirements:
- The business must have Express QES identification evidence enabled. If it is not,
the request fails with
403 Forbidden(problem typefeature-not-enabled). - The identification process must be completed (
evidence_idis required).
path Parameters
SR_IDUnique ID received when creating the Signature Request object
EVIDENCE_IDUnique ID of the identification evidence record, available in the signer_identity_data.evidence_id field of the SignatureRequest response once identification is complete.
Get Identification Evidence JWT › Responses
OK
Signed JWT representing the identification evidence.