Returns the long-term preservation certificates associated with a specific verification session
When to use this endpoint
- Use this endpoint to retrieve the cryptographic preservation certificates generated for a verification session
- A certificate provides proof that the session data existed in its current form at the certified moment in time, and that it has not been altered since
- Common use cases include:
- Obtaining a certificate for archival or regulatory compliance purposes
- Retrieving the source documents that a certificate attests to
- Building an audit trail that demonstrates the integrity of verification records
- This endpoint is currently available as part of the Mexico - NOM-151 Certification solution
Response data
Returns a list of certificate objects associated with the specific
sessionId. Each object includes:- Unique identifier (
id), certificatekind(for examplenom-151-certificate) andformat(for examplepkcs7) value: the certificate itself, as a Base64-encoded CMS/PKCS#7 signed timestamp tokencreatedAt: the time the certificate was generatedmetadata: certificate authority metadata, including the certificate serial number, issue date, hash algorithm and hashsourceDocuments: the documents that the certificate attests to, each with a downloadurl
- Unique identifier (
The
metadatafields are populated from the certificate authority response. Any field that the authority does not return is set to null.
Implementation notes
- Use the
sourceDocuments[].urlvalue together with GET /v1/sessions//certificates//files/ to download the document a certificate attests to - An empty
certificatesarray indicates that no certificate has been generated for the session yet - A maximum of 2 certificates is returned. Pagination is not available
- This endpoint requires session-level HMAC signature authentication
- Always ensure that you use the correct API URL to send requests. See the API URL section for more info
- The order of parameters in the real API response can differ from the order you see in this documentation. This is expected and part of the Backwards compatible changes requirements
Your integration's API key (occasionally referred to as the "Token", "API public key" or "Publishable key"). Required for all API requests.
You can find your API key in the Veriff Customer Portal > Settings > API keys.
Session ID signed with the shared secret key. Required to authenticate the request sender.
Verification session ID.
Session certificates retrieved successfully
Session with a NOM-151 preservation certificate
{
"status": "success",
"certificates": [
{
"id": "27d303bb-6a1f-4c2e-9b1d-2f3a4b5c6d7e",
"kind": "nom-151-certificate",
"format": "pkcs7",
"value": "MIIPwTADAgEAMIIPuAYJKoZIhvcNAQcCoIIPqTCCD6UCAQMxDzANBglghkgBZQMEAgEFADCCAc0...",
"createdAt": "2026-06-15T09:17:53Z",
"metadata": {
"certificateNumber": "02377f31",
"issueDate": "2026-06-15T09:17:53Z",
"hashAlgorithm": "sha256",
"hash": "eJ8olhK7cR5v2iKnbFuRKngydS1Si6KVevSycRN6/dg="
},
"sourceDocuments": [
{
"id": "a6a27f7a-3c4d-4e5f-8a9b-0c1d2e3f4a5b",
"url": "/v1/sessions/d69a07cf-4434-4d36-be6c-d22af7dc01fb/certificates/27d303bb-6a1f-4c2e-9b1d-2f3a4b5c6d7e/files/a6a27f7a-3c4d-4e5f-8a9b-0c1d2e3f4a5b"
}
]
}
]
}Session with no certificate generated yet
{
"status": "success",
"certificates": []
}List of long-term preservation certificates generated for a verification session.
API request status
Array of certificate objects generated for the session. Empty when no certificate has been generated yet.
A single long-term preservation certificate and the source documents it attests to.
Unique identifier of the certificate.
The kind of certificate. Identifies the preservation standard the certificate was issued under.
The encoding format of the certificate value.
The certificate itself, as a Base64-encoded CMS/PKCS#7 signed timestamp token.
The time the certificate was generated. Expressed in UTC and ends with the letter Z.
Certificate authority metadata describing the issued certificate.
Serial number of the certificate, as assigned by the certificate authority. Set to null when not provided.
The moment the certificate authority certified the data. Expressed in UTC and ends with the letter Z. Set to null when not provided.
The hash algorithm used to compute the certified hash. Set to null when not provided.
The hash of the certified data. Set to null when not provided.
The documents that the certificate attests to. Each document can be downloaded using its url.
A document that a certificate attests to.
Unique identifier of the source document.
Relative URL used to download the source document file.
Unauthorized
{
"status": "fail",
"code": "1101",
"message": "Mandatory X-AUTH-CLIENT header containing the API key is missing from the request."
}Session not found
{
"status": "fail",
"code": "1101",
"message": "Resource not found"
}Internal server error
{
"status": "fail",
"code": "1101",
"message": "Something went wrong"
}Changelog
Date | Description |
|---|---|
Sep 4, 2026 | Documentation created |