PingOne Platform APIs

Verify Documents

For each verification transaction, you can read documents (such as the images of documents and images of the user, "selfies") submitted to the transaction for a short time. The documents endpoint, /environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/documents, receives all requests for documents associated with the verification transaction. This endpoint returns the data regardless of whether the transaction is ever submitted for verification.

Only those with an Identity Data Admin role are permitted to use the documents endpoint.

Documents are retained for 30 minutes after creating or updating the document (submitted with the requests Create Verification Document or Update Verification Document or collected by the end user in the Universal Capture frontend) or until manually deleted with Delete Verification Document. Until removed, any number of GET or PUT requests to the documents endpoint can be successfully performed.

The document types accepted by a verify transaction is determined by the verify transaction’s requirements object and the verify policy identified by the verify transaction’s verifyPolicy.id. If a document is unacceptable, an error is returned that is similar to:

{
    "id": "05f2cbb8-bd1b-41b1-abf0-d5fc4fc4c875",
    "code": "INVALID_DATA",
    "message": "The request could not be completed. One or more validation errors were in the request.",
    "details": [
        {
            "code": "INVALID_VALUE",
            "target": "type",
            "message": "invalid document type for transaction"
        }
    ]
}

All verify documents data model

When all verify documents for a verification transaction are requested, the verify document for each verification type of the most recent retry appears in a documents array in the response. The verify document data model for each verification type of earlier retries appear in a previousAttempts array in the response.

Property Type Required? Mutable? Description

_embedded

Object

N/A

Read-only

Container for returned data.

documents

Object[]

N/A

Read-only

Array of verifiedData objects for each verification type for the most recent verification attempt.

previousAttempts

Object[]

N/A

Read-only

Array of verifiedData objects for each verification type for unacceptable verification attempts.

size

Integer

N/A

Read-only

The number of objects returned in documents.

Specific verify document data model

When specific verify document for a verification type within a verification transaction are requested, the verify document data model appears as the response, regardless of which retry attempt it is.

Verify document data model

Property Type Required? Mutable? Description

id

String

N/A

Read-only

Document identifier (UUID)

retry.attempt

Integer

N/A

Read-only

Number of the retry attempt when submitting images.

source.provider

String

Required

Immutable

Provider of the documents. Can be END_USER, AUTHENTICATED_CLIENT.

status

String

N/A

Read-only

Status of the document. Can be COLLECTED or PROCESSED.

type

String

Required

Immutable

Type of document in value. Refer to Document types and values.

value

String

Required

Immutable

Document, for the format of the document refer to Document types and values

Document types and values

Document Type Value

Document Back

Base64 encoded JPEG

Document Front

Base64 encoded JPEG

Driver License Back

Base64 encoded JPEG

Driver License Code

decoded text from the PDF417 barcode

Driver License Front

Base64 encoded JPEG

Email

textual email address

Passport Card Back

Base64 encoded JPEG

Passport Card Front

Base64 encoded JPEG

Passport Front

Base64 encoded JPEG

Phone

textual phone number

Selfie

Base64 encoded JPEG

Voice Input

Base64 encoded LPCM WAV voice recording submitted for verification

Voice Sample

Base64 encoded LPCM WAV voice recording submitted for enrollment

Voice verification is deprecated and will be removed on November 25, 2026.
Voice recordings must be sampled at 16 KHz when submitted from reading voice phrases (deprecated) or at 8 KHz when submitted from longer, text-independent recordings.