PingOne Platform APIs - Early Access

Verification MetaData

For each verification attempt, you can retrieve all scores in the transaction returned from verification services. The metaData endpoint, /v1/environments/{{envID}}/users/{{userID}}/verifyTransactions/{{transactionID}}/metaData, receives all requests for scores associated with the verification attempt and returned from verification services.

All verification metaData data model

When all metaData for a verification transaction are requested, the verification metaData for each verification type of the most recent retry appears in a metaData array in the response. The verification metaData 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.

metaData

Object[]

N/A

Read-only

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

previousAttempts

Object[]

N/A

Read-only

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

size

Integer

N/A

Read-only

The number of objects returned in metaData.

Specific verification metaData data model

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

Verification metaData data model

Property Type Required Mutable Description

data

Object

N/A

Read-only

Data model by provider and type as seen in the Data model column of data object data model.

id

String

N/A

Read-only

Identifier (UUID) of the transaction metaData.

provider

String

N/A

Read-only

The provider of metaData in the object as seen in the Provider column of data object data model.

retry.attempt

Integer

N/A

Read-only

Number of the retry attempt when submitting images.

status

String

N/A

Read-only

Status of the check. Can be SUCCESS or FAIL.

type

String

N/A

Read-only

The type of metaData in the object as seen in the Type column of data object data model.

data object data model

The data object in verification metaData varies depending on the values of type and provider as seen in the table.

Type Provider Data model

DOCUMENT_AUTHENTICATION

SIGNICAT

data model

data object for DOCUMENT_AUTHENTICATION + SIGNICAT [EA]

Signicat provides document authentication using Near Field Communication (NFC), which securely reads the embedded chip in "smart" documents.

Property Type Required Mutable Description

sessionId

String

N/A

Read-only

Provider’s session identifier (UUID) for the verification.

success

Boolean

N/A

Read-only

Whether or not the verification was successful.

finishingState

String

N/A

Read-only

Final state of the verification. Can be NOT_STARTED, BUSY, or DONE.

activeAuthentication

String

N/A

Read-only

Active authentication verdict. Refer to Verification Status Verdict

activeAuthenticationReason

String

N/A

Read-only

Reason for the active authentication verdict. Can be null. Refer to Verification Status Reason Code.

countrySigner

String

N/A

Read-only

Country signer verification verdict. Refer to Verification Status Verdict.

countrySignerReason

String

N/A

Read-only

Reason for the country signer verification verdict. Can be null. Refer to Verification Status Reason Code.

documentSigner

String

N/A

Read-only

Document signer verification verdict. Refer to Verification Status Verdict.

documentSignerReason

String

N/A

Read-only

Reason for the document signer verification verdict. Can be null. Refer to Verification Status Reason Code.

extendedChipAuthentication

String

N/A

Read-only

Extended chip authentication verdict. Refer to Verification Status Verdict.

extendedChipAuthenticationReason

String

N/A

Read-only

Reason for the extended chip authentication verdict. Can be null. Refer to Verification Status Reason Code.

hashTable

String

N/A

Read-only

Hash table verification verdict. Refer to Verification Status Verdict.

hashTableReason

String

N/A

Read-only

Reason for the hash table verification verdict. Can be null. Refer to Verification Status Reason Code.
Verification Status Verdict
Verdict Description

NOT_PRESENT

Item is not present

PRESENT_FAILED

Item is present but failed verification, check the corresponding Reason for details.

PRESENT_NOT_CHECKED

Item is present but was not checked for verification.

PRESENT_SUCCEEDED

Item is present and successfully verified.

UNKNOWN

Item’s verification status is unknown.
Verification Status Reason Code
Reason Code Description

ALL_HASHES_MATCH

All hashes (that were computed of data-groups read) match (with hashes stored in the security object document). This is the successful case for hash table verification.

CERTIFICATE_EXPIRED

Certificate expired.

COULD_NOT_BUILD_CHAIN_FAILURE

Could not build certificate chain. This is the abnormal failure case for country signer verification.

FOUND_A_CHAIN_SUCCEEDED

Found a certificate chain to a trust anchor. This is the successful case for country signer verification.

HASH_MISMATCH_FAILURE

Hash mismatch failure. This is a failure case for hash table verification.

NO_CSCA_TRUST_ANCHORS_FOUND_FAILURE

No Country Signer Certificate Authority root certificates (trust anchors) were found. This is a failure case for country signer verification.

NO_VERIFIER

The verifier was not configured.

NON_MATCH_ALERT

Non-matched verification.

NOT_SUPPORTED

The specific mechanism is not supported by the chip.

PRESENCE_DETECTED

The specific mechanism is present (supported by the chip).

READ_ERROR_CONFIGURATION_FAILURE

The reader or the verifier could not be configured correctly.

READ_ERROR_SOD_FAILURE

The verifier could not acquire or parse the chip’s security object document.

SIGNATURE_CHECKED

The signature checked. This is the successful case for active authentication and document signer verification.

SIGNATURE_FAILURE

The signature failed. This is a failure case for active authentication and document signer verification.

STORED_HASH_NOT_FOUND

The stored hash could not be found. This is a failure case for hash table verification.

SUCCEEDED

The verification succeeded. This is the general successful case for verification.

UNEXPECTED_EXCEPTION_FAILURE

Reader or verifier encountered an unexpected exception. This is a general failure case for verification.

UNKNOWN

Item’s verification status is unknown. No further information could be determined. Default value.

UNSUPPORTED_DIGEST_ALGORITHM_FAILURE

The verification requires a digest algorithm not supported by the verifier. This is a failure case for hash table verification.

UNSUPPORTED_KEY_TYPE_FAILURE

Unsupported key type failure during verification.

UNSUPPORTED_DIGEST_SIGNATURE_FAILURE

The verification requires a signature algorithm not supported by the verifier. This is a failure case for active authentication and document signer verification.