PingOne Advanced Identity Cloud

PingOne Verify Completion Decision node API

The PingOne Verify Completion Decision node script is a next-generation script and therefore has access to all the next-generation common bindings.

Access PingOne Verify transactions and manage associated user

Use the methods in the verifyTransactionsHelper class to obtain information about PingOne Verify transactions the user has performed, and manage the associated user account in PingOne.

Methods

Map getLastVerifyTransaction()

Retrieve the user’s most recent transaction they performed with PingOne Verify.

Returns a map containing data about the most recent transaction or null if no transactions are available.

View example return data 
{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-fak3-49f5-a5d9-80ad5c98f9f6/users/36ff33da-abc7-ch15-abab-8b2412345461/verifyTransactions/dd5a6d4f-m0nd-0819-b107-85a0a10138c6"},
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-fak3-49f5-a5d9-80ad5c98f9f6"},
        "user": {
            "href": "https://api.pingone.com/v1/users/36ff33da-abc7-ch15-abab-8b2412345461"}
    },
    "id": "dd5a6d4f-m0nd-0819-b107-85a0a10138c6",
    "transactionStatus": {
        "status": "SUCCESS",
        "verificationStatus": {
            "GOVERNMENT_ID": "SUCCESS",
            "LIVENESS": "SUCCESS",
            "FACIAL_COMPARISON_DOCUMENT": "SUCCESS"
        }
    },
    "verifiedDocuments": "[selfie, liveness, driver_license]",
    "createdAt": "2024-12-09T13:45:34.882Z",
    "updatedAt": "2024-12-09T13:45:34.882Z",
    "expiresAt": "2024-12-09T14:15:34.882Z"
}
Map getAllVerifyTransactions()

Retrieve all the user’s transactions performed with PingOne Verify.

Returns a map containing data about all transactions or null if no transactions are available.

View example return data 
{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/36ff33da-cba7-4d46-bedc-8b242889d461/verifyTransactions"
        }
    },
    "_embedded": {
        "verifyTransactions": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/36ff33da-cba7-4d46-bedc-8b242889d461/verifyTransactions/029ea878-2618-4067-b7e3-922591e6b55f"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "https://api.pingone.com/v1/users/36ff33da-cba7-4d46-bedc-8b242889d461"
                    }
                },
                "id": "029ea878-2618-4067-b7e3-922591e6b55f",
                "transactionStatus": {
                    "status": "APPROVED_NO_REQUEST"
                },
                "createdAt": "2022-02-17T20:32:22.052Z",
                "updatedAt": "2022-02-17T20:32:58.711Z",
                "expiresAt": "2022-02-17T21:02:58.711Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/36ff33da-cba7-4d46-bedc-8b242889d461/verifyTransactions/cca479e7-d130-4e3c-b888-74ba1920f59a"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "https://api.pingone.com/v1/users/36ff33da-cba7-4d46-bedc-8b242889d461"
                    }
                },
                "id": "cca479e7-d130-4e3c-b888-74ba1920f59a",
                "transactionStatus": {
                    "status": "REQUESTED"
                },
                "qrUrl": "https://api.pingone.com/v1/idValidations/shortcode/086645084110/qr",
                "verificationCode": "086645084110",
                "createdAt": "2022-02-17T20:23:58.662Z",
                "updatedAt": "2022-02-17T20:23:58.662Z",
                "expiresAt": "2022-02-17T20:53:58.662Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/36ff33da-cba7-4d46-bedc-8b242889d461/verifyTransactions/52c9bf9a-0687-4e01-85d1-9caa9bb387ee"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "https://api.pingone.com/v1/users/36ff33da-cba7-4d46-bedc-8b242889d461"
                    }
                },
                "id": "52c9bf9a-0687-4e01-85d1-9caa9bb387ee",
                "transactionStatus": {
                    "status": "REQUESTED"
                },
                "qrUrl": "https://api.pingone.com/v1/idValidations/shortcode/008299320746/qr",
                "verificationCode": "008299320746",
                "createdAt": "2022-02-17T20:23:08.887Z",
                "updatedAt": "2022-02-17T20:23:08.887Z",
                "expiresAt": "2022-02-17T20:53:08.887Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/36ff33da-cba7-4d46-bedc-8b242889d461/verifyTransactions/dd5a6d4f-a999-4819-b107-85a0a10138c6"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "https://api.pingone.com/v1/users/36ff33da-cba7-4d46-bedc-8b242889d461"
                    }
                },
                "id": "dd5a6d4f-a999-4819-b107-85a0a10138c6",
                "transactionStatus": {
                    "status": "REQUESTED"
                },
                "createdAt": "2021-12-09T13:45:34.882Z",
                "updatedAt": "2021-12-09T13:45:34.882Z",
                "expiresAt": "2022-12-09T14:15:34.882Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/36ff33da-cba7-4d46-bedc-8b242889d461/verifyTransactions/bfc414cb-a1b4-46b8-b622-3d806a85002f"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "https://api.pingone.com/v1/users/36ff33da-cba7-4d46-bedc-8b242889d461"
                    }
                },
                "id": "bfc414cb-a1b4-46b8-b622-3d806a85002f",
                "transactionStatus": {
                    "status": "REQUESTED"
                },
                "createdAt": "2021-12-08T21:34:52.424Z",
                "updatedAt": "2021-12-08T21:34:52.424Z",
                "expiresAt": "2022-12-08T22:04:52.424Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/36ff33da-cba7-4d46-bedc-8b242889d461/verifyTransactions/b21db4c4-01c5-47b5-a2a9-3d8df21d189b"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "https://api.pingone.com/v1/users/36ff33da-cba7-4d46-bedc-8b242889d461"
                    }
                },
                "id": "b21db4c4-01c5-47b5-a2a9-3d8df21d189b",
                "transactionStatus": {
                    "status": "APPROVED_NO_REQUEST"
                },
                "createdAt": "2021-12-07T21:33:22.088Z",
                "updatedAt": "2021-12-07T21:45:22.944Z",
                "expiresAt": "2022-12-07T22:15:22.944Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/36ff33da-cba7-4d46-bedc-8b242889d461/verifyTransactions/e44ebfe2-6a76-4ffa-ac35-d71ee9365e57"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "https://api.pingone.com/v1/users/36ff33da-cba7-4d46-bedc-8b242889d461"
                    }
                },
                "id": "e44ebfe2-6a76-4ffa-ac35-d71ee9365e57",
                "transactionStatus": {
                    "status": "APPROVED_NO_REQUEST"
                },
                "createdAt": "2021-12-07T19:55:16.630Z",
                "updatedAt": "2021-12-07T21:31:26.835Z",
                "expiresAt": "2022-12-07T22:01:26.835Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/36ff33da-cba7-4d46-bedc-8b242889d461/verifyTransactions/fc695b11-93a4-48bb-9ec3-ff5738e3818c"
                    },
                    "environment": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "https://api.pingone.com/v1/users/36ff33da-cba7-4d46-bedc-8b242889d461"
                    }
                },
                "id": "fc695b11-93a4-48bb-9ec3-ff5738e3818c",
                "transactionStatus": {
                    "status": "REQUESTED"
                },
                "createdAt": "2021-12-07T18:36:48.156Z",
                "updatedAt": "2021-12-07T18:36:48.156Z",
                "expiresAt": "2021-12-07T19:06:48.153Z"
            }
        ]
    },
    "size": 8
}
Map getAllMetadata(String transactionId)

Retrieve the metadata for a specified transaction.

Metadata includes information about the reasons behind a transaction decision, such as scores, probability, and the judgements made, rather than the actual data provided to the transaction by the user.

Returns a map containing the details of the transaction result from the verification services used, or null if the specified transaction is not available.

View example return data 
{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData"
        },
        "user": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "verifyTransaction": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6"
        }
    },
    "_embedded": {
        "metaData": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData/4ebb9165-4e5c-4270-94e4-d50d7b17ecb4"
                    }
                },
                "id": "4ebb9165-4e5c-4270-94e4-d50d7b17ecb4",
                "provider": "IDRND",
                "type": "LIVENESS",
                "status": "SUCCESS",
                "data": {
                    "score": 6.4909873,
                    "probability": 0.99848527,
                    "quality": 0.94462675
                },
                "retry": {
                    "attempt": 2
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData/ae186d6c-1a79-4912-bad8-79afa3626cca"
                    }
                },
                "id": "ae186d6c-1a79-4912-bad8-79afa3626cca",
                "provider": "IDRND",
                "type": "INJECTION_DETECTION",
                "status": "SUCCESS",
                "data": {
                    "probability": 1.0
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData/546d3a8e-f606-4078-92f1-96a5c2d003e9"
                    }
                },
                "id": "546d3a8e-f606-4078-92f1-96a5c2d003e9",
                "provider": "AMAZON",
                "type": "FACIAL_COMPARISON",
                "status": "SUCCESS",
                "data": {
                    "similarity": 99.37002,
                    "confidence": 99.99767,
                    "quality": {
                        "brightness": 36.77353,
                        "sharpness": 20.92731
                    }
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData/96315a69-fb46-4d28-9b0d-c79927e59df1"
                    }
                },
                "id": "96315a69-fb46-4d28-9b0d-c79927e59df1",
                "provider": "BIOGRAPHIC_MATCHER",
                "type": "BIOGRAPHIC_MATCH",
                "status": "SUCCESS",
                "data": {
                    "biographic_match_results": [
                        {
                            "identifier": "address",
                            "match": "NOT_APPLICABLE"
                        },
                        {
                            "identifier": "given_name",
                            "match": "NONE"
                        },
                        {
                            "identifier": "family_name",
                            "match": "HIGH"
                        },
                        {
                            "identifier": "birth_date",
                            "match": "HIGH"
                        }
                    ]
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData/fba13756-8c24-49ff-9b42-ff1a3661d0ae"
                    }
                },
                "id": "fba13756-8c24-49ff-9b42-ff1a3661d0ae",
                "provider": "MITEK",
                "type": "DOCUMENT_AUTHENTICATION",
                "status": "SUCCESS",
                "data": {
                    "mitekVerifications": [
                        {
                            "name": "Document Ensemble Authenticator",
                            "judgement": "Authentic",
                            "verificationType": 202,
                            "probability": 753,
                            "version": "3.47.0.7114",
                            "documentId": "048f28f1-a7fe-42a5-9722-f10977606719"
                        },
                        {
                            "name": "Black And White Copy",
                            "judgement": "Authentic",
                            "verificationType": 102,
                            "probability": 717,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "Image Classification",
                            "judgement": "Authentic",
                            "verificationType": 105,
                            "probability": 1000,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "Data Comparison",
                            "judgement": "Authentic",
                            "verificationType": 700,
                            "probability": 1000,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "Ensemble Authenticator",
                            "judgement": "Authentic",
                            "verificationType": 201,
                            "probability": 753,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "ID Document Blacklist",
                            "judgement": "Authentic",
                            "verificationType": 101,
                            "probability": 1000,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "Generic Font",
                            "judgement": "Authentic",
                            "verificationType": 104,
                            "probability": 926,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "MRZ Check Digit",
                            "judgement": "Authentic",
                            "verificationType": 601,
                            "probability": 1000,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "MRZ Font Type Authentication",
                            "judgement": "Authentic",
                            "verificationType": 600,
                            "probability": 1000,
                            "version": "3.47.0.7114",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "Image Processing",
                            "judgement": "Authentic",
                            "verificationType": 710,
                            "probability": 1000,
                            "version": "1.0",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        },
                        {
                            "name": "Document Liveness",
                            "judgement": "Authentic",
                            "verificationType": 108,
                            "probability": 999,
                            "version": "1.0",
                            "documentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856"
                        }
                    ],
                    "frontImageDocumentId": "e290d74d-bf9c-4116-9fe7-9b6fb909c856",
                    "documentEvidenceId": "048f28f1-a7fe-42a5-9722-f10977606719",
                    "retry": {
                        "attempt": 1
                    }
                }
            }
        ]
    },
    "previousAttempts": [
        {
            "_links": {
                "self": {
                    "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/03df72b1-b80b-4449-8eef-ee8f85f48d94/verifyTransactions/7668563d-0226-4ca5-8401-03f6dc5bcdc6/metaData/06aebfbd-0053-4860-8b59-4f3cb7371dcb"
                }
            },
            "id": "06aebfbd-0053-4860-8b59-4f3cb7371dcb",
            "provider": "IDRND",
            "type": "LIVENESS",
            "status": "FAIL",
            "data": {
                "score": 2.4509223,
                "probability": 0.40062885,
                "quality": 0.40874674
            },
            "retry": {
                "attempt": 1
            }
        }
    ],
    "size": 5
}
Map getAllVerifiedData(String transactionId)

For up to 30 minutes after a PingOne Verify decision, you can retrieve information about all the data obtained by all the verification service providers during the specified transaction.

Returns a map containing information about the data returned from the verification service used, or null if the specified transaction is not available.

This method lists only the ID and type of verified data available, as the actual data could be large binary files such as images.

Use the getVerifiedData() method to get the actual verified data.
View example return data 
{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b/verifiedData/"
        },
        "user": {
            "href": "https://api.pingone.com/v1/users/a27dec16-1e80-4f10-a261-2cac46a12b78"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "transaction": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b"
        }
    },
    "_embedded": {
        "verifiedData": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b/verifiedData/84170421-62c6-49a5-b343-496bee93c206"
                    }
                },
                "id": "84170421-62c6-49a5-b343-496bee93c206",
                "type": "GOVERNMENT_ID",
                "createdAt": "2022-02-23T15:51:01.603Z",
                "retry": {
                    "attempt": 2
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b/verifiedData/ef6cd8cd-d869-4695-af69-29c78b6f041a"
                    }
                },
                "id": "ef6cd8cd-d869-4695-af69-29c78b6f041a",
                "type": "SELFIE",
                "createdAt": "2022-02-25T16:22:35.649Z",
                "retry": {
                    "attempt": 2
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b/verifiedData/bf6cd8cd-d869-4695-af69-29c78b6f041a"
                    }
                },
                "id": "bf6cd8cd-d869-4695-af69-29c78b6f041a",
                "type": "BACK_IMAGE",
                "createdAt": "2022-02-25T16:22:35.649Z",
                "retry": {
                    "attempt": 2
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b/verifiedData/af6cd8cd-d869-4695-af69-29c78b6f041a"
                    }
                },
                "id": "af6cd8cd-d869-4695-af69-29c78b6f041a",
                "type": "FRONT_IMAGE",
                "createdAt": "2022-02-25T16:22:35.649Z",
                "retry": {
                    "attempt": 2
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b/verifiedData/:id"
                    }
                },
                "id": "yf6cd8cd-d869-4695-af69-29c78b6f041a",
                "type": "CROPPED_PORTRAIT",
                "createdAt": "2022-02-25T16:22:35.649Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b/verifiedData/:id"
                    }
                },
                "id": "vf6cd8cd-d869-4695-af69-29c78b6f041a",
                "type": "CROPPED_DOCUMENT",
                "createdAt": "2022-02-25T16:22:35.649Z"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b/verifiedData/:id"
                    }
                },
                "id": "if6cd8cd-d869-4695-af69-29c78b6f041a",
                "type": "CROPPED_SIGNATURE",
                "createdAt": "2022-02-25T16:22:35.649Z"
            }
        ],
        "previousAttempts": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b/verifiedData/320f341f-050b-4351-9585-5f16dba6667c"
                    }
                },
                "id": "320f341f-050b-4351-9585-5f16dba6667c",
                "type": "GOVERNMENT_ID",
                "createdAt": "2022-02-23T15:51:01.603Z",
                "retry": {
                    "attempt": 1
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b/verifiedData/ce0bb6d8-82d5-4ad0-b348-e7fb97edc64f"
                    }
                },
                "id": "ce0bb6d8-82d5-4ad0-b348-e7fb97edc64f",
                "type": "SELFIE",
                "createdAt": "2022-02-25T16:22:35.649Z",
                "retry": {
                    "attempt": 1
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b/verifiedData/639116d2-c1ff-44f3-bdba-af7e1e1d0bdd"
                    }
                },
                "id": "639116d2-c1ff-44f3-bdba-af7e1e1d0bdd",
                "type": "BACK_IMAGE",
                "createdAt": "2022-02-25T16:22:35.649Z",
                "retry": {
                    "attempt": 1
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b/verifiedData/92faff31-02c5-43af-b09a-c7eac93c59a4"
                    }
                },
                "id": "92faff31-02c5-43af-b09a-c7eac93c59a4",
                "type": "FRONT_IMAGE",
                "createdAt": "2022-02-25T16:22:35.649Z",
                "retry": {
                    "attempt": 1
                }
            }
        ]
    },
    "size": 7
}
Map getVerifiedDataByType(String transactionId, String type)

For up to 30 minutes after a PingOne Verify decision, you can retrieve information about a specified type of data obtained by all the verification service providers during the specified transaction.

Use the type parameter to specify which type of personally identifiable information (PII) to retrieve.

Available options are:

  • GOVERNMENT_ID

  • BARCODE

  • FRONT_IMAGE

  • BACK_IMAGE

  • SELFIE

  • CROPPED_SIGNATURE

  • CROPPED_DOCUMENT

  • CROPPED_PORTRAIT

  • VOICE_SAMPLE

  • VOICE_INPUT

  • END_USER_CLIENT

  • BIOGRAPHIC_MATCH

Returns a map containing information about the data returned from the verification service used, or null if the specified transaction is not available.

This method lists only the ID and type of verified data available, as the actual data could be large binary files such as images.

Use the getVerifiedData() method to get the actual verified data.
Map getVerifiedData(String transactionId, String verifiedDataId)

For up to 30 minutes after a PingOne Verify decision, you can retrieve the actual data the verification service obtained during the specified transaction.

Returns a map containing verified data returned from a verification service used, or null if the specified transaction or verified data ID are not available.

To obtain the verifiedDataId parameter, use the getAllVerifiedData() or getVerifiedDataByType() methods.
View example return data 
{
    "_links":{
        "self":{
            "href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b/verifiedData/34613a50-672c-428f-8db9-c67fe09fc4cc"
        },
        "environment":{
            "href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "user":{
            "href":"https://api.pingone.com/v1/users/a27dec16-1e80-4f10-a261-2cac46a12b78"
        },
        "transaction":{
            "href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/a27dec16-1e80-4f10-a261-2cac46a12b78/verifyTransactions/0e2ed48f-6c3a-46c4-bcb5-3a6bd791348b"
        }
    },
    "id":"84170421-62c6-49a5-b343-496bee93c206",
    "type":"GOVERNMENT_ID",
    "createdAt":"2022-02-23T15:51:01.603Z",
    "data":{
        "addressCity":"this city",
        "addressState":"this state",
        "addressZip":"11111",
        "birthDate":"1970-01-01",
        "country":"USA",
        "expirationDate":"1970-01-01",
        "firstName":"given",
        "gender":"",
        "idNumber":"11111",
        "issueDate":"1970-01-01",
        "issuingCountry":"",
        "lastName":"surname",
        "nationality":"",
        "weight":""
    },
    "retry":{
        "attempt":1
    }
}
Map getUser()

Retrieve the user’s profile information from PingOne.

Returns a map containing user profile data from PingOne, or null if profile data is not available.

View example return data 
{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "population": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/706ff5fd-c2bc-4c2d-9037-bfa39112a651"
        },
        "devices": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/devices"
        },
        "roleAssignments": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/roleAssignments"
        },
        "password": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"
        },
        "password.reset": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"
        },
        "password.set": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"
        },
        "password.check": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"
        },
        "password.recover": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"
        },
        "linkedAccounts": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/linkedAccounts"
        },
        "account.sendVerificationCode": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5"
        }
    },
    "_embedded": {
        "population": {
            "_links": {
                "self": {
                    "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/706ff5fd-c2bc-4c2d-9037-bfa39112a651"
                },
                "environment": {
                    "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                }
            },
            "id": "706ff5fd-c2bc-4c2d-9037-bfa39112a651"
        }
    },
    "id": "2f9c3699-217e-4acb-9e80-9649311b3eb5",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "population": {
        "id": "706ff5fd-c2bc-4c2d-9037-bfa39112a651"
    },
    "createdAt": "2020-03-11T18:50:09.074Z",
    "enabled": true,
    "lifecycle": {
        "status": "ACCOUNT_OK"
    },
    "mfaEnabled": false,
    "updatedAt": "2020-03-11T18:50:09.074Z",
    "username": "jamesjoyce"
}
Map updateUser(Map body)

Update the user’s profile information in PingOne.

Specify the new data to use in the body parameter.

Returns a map containing the updated user profile data from PingOne.

View example body parameter 
{
    "username": "joe@example.com",
    "name": {
        "formatted": "Joe Smith",
        "given": "Joe",
        "middle": "H.",
        "family": "Smith",
        "honorificPrefix": "Dr.",
        "honorificSuffix": "IV"
    },
    "nickname": "Putty",
    "title": "Senior Director",
    "preferredLanguage": "en-gb;q=0.8, en;q=0.7",
    "locale": "en-gb",
    "email": "joe@example.com",
    "primaryPhone": "+1.2225554444",
    "mobilePhone": "+1.4445552222",
    "photo": {
        "href": "https://images.example.com?imgID=1255123412"
    },
    "address": {
        "streetAddress": "123 Main Street",
        "locality": "Springfield",
        "region": "WA",
        "postalCode": "98701",
        "countryCode": "US"
    },
    "accountId": "5",
    "type": "tele",
    "timezone": "America/Los_Angeles"
}
Void deleteUser()

Delete the user’s profile information from PingOne.

Throws a ScriptedVerifyTransactionsException if unable to delete the user from PingOne.

View example return data 
{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "population": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/706ff5fd-c2bc-4c2d-9037-bfa39112a651"
        },
        "devices": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/devices"
        },
        "roleAssignments": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/roleAssignments"
        },
        "password": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"
        },
        "password.reset": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"
        },
        "password.set": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"
        },
        "password.check": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"
        },
        "password.recover": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/password"
        },
        "linkedAccounts": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5/linkedAccounts"
        },
        "account.sendVerificationCode": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/2f9c3699-217e-4acb-9e80-9649311b3eb5"
        }
    },
    "_embedded": {
        "population": {
            "_links": {
                "self": {
                    "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/706ff5fd-c2bc-4c2d-9037-bfa39112a651"
                },
                "environment": {
                    "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                }
            },
            "id": "706ff5fd-c2bc-4c2d-9037-bfa39112a651"
        }
    },
    "id": "2f9c3699-217e-4acb-9e80-9649311b3eb5",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "population": {
        "id": "706ff5fd-c2bc-4c2d-9037-bfa39112a651"
    },
    "createdAt": "2020-03-11T18:50:09.074Z",
    "enabled": true,
    "lifecycle": {
        "status": "ACCOUNT_OK"
    },
    "mfaEnabled": false,
    "updatedAt": "2020-03-11T18:50:09.074Z",
    "username": "jamesjoyce"
}