success | boolean | True if the API call was successful. | ✅ |
phoneNumber | string | The number of the mobile phone. | ✅ |
verifyResult | string | The result of the verification according to the Global Fraud Policy. | ✅ |
assuranceLevel | string | Prove’s tiered confidence metric, ranging from -1 to 3, that dynamically adapts to user behavior and various authentication keys. It allows for adaptive security policies, meaning you can require different levels of verification for different types of transactions. This is a key attribute of the Prove Key. Possible values are: “AL-1”, “AL0”, “AL1”, “AL2”, “AL3”. | ✅ |
correlationId | string | The unique ID that Prove generates for the flow. To continue the flow, the field will also be used for each of the subsequent API calls in the same flow - it cannot be reused outside of a single flow. | ✅ |
proveId | string | A globally unique identifier in Prove language that represents a user (or business). If provided to a customer, this ID is “salted” to make it specific to that customer before being shared. It links a user’s keys to their National ID and is the center of our universe linking identity data and events throughout our fabric. | ✅ |
proveKey | string | | ✅ |
identityId | string | | ✅ |
clientRequestID | string | | ✅ |
clientHumanID | string | A client-generated unique ID for a specific customer that has been identity proofed. This can be used by clients to link calls related to the same customer, across different requests or sessions. The format of this ID is defined by the client - Prove recommends using a GUID, but any format can be accepted. Do not include personally identifiable information (PII) in this field. | ✅ |
clientCustomerId | string | A client-generated unique ID for a specific customer. This can be used by clients to link calls related to the same customer, across different requests or sessions. | ✅ |
identity | list of objects | | ✅ |
firstName | string | The first name of the individual. | ✅ |
lastName | string | The last name of the individual. | ✅ |
nationalId | string | The national identity number of the individual. | ✅ |
dateOfBirth | string | The date of birth of the individual in one of these formats: YYYY-MM-DD, YYYY-MM, or MM-DD. Acceptable characters are: numeric with symbol ’-’. | ✅ |
email(s) | list of objects | ✅ | |
email1 | string | The email address of the customer. Acceptable characters are: alphanumeric with symbols ’@.+’. | ✅ |
email2 | string | The email address of the customer. Acceptable characters are: alphanumeric with symbols ’@.+’. | ✅ |
address | list of objects | ✅ | |
address | string | The street address of the individual. | ✅ |
extendedAddress | string | The apartment number or other extended address information. | ✅ |
city | string | The city of the individual. | ✅ |
region | string | The state or locality of the individual. | ✅ |
zipCode | string | The zip code of the individual. It can be either 5 digits (XXXXX) or ZIP+4 (XXXXX-XXXX). | ✅ |
business(es) | list of objects | | |
businessName | string | The legal business name. | |
businessAddress | list of objects | | |
address | string | The street address of the individual. | |
extendedAddress | string | The apartment number or other extended address information. | |
city | string | The city of the individual. | |
region | string | The state or locality of the individual. | |
zipCode | string | The zip code of the individual. It can be either 5 digits (XXXXX) or ZIP+4 (XXXXX-XXXX). | |
tradeName | string | The doing business as (DBA) name of the legal business entity. | |
taxId | string | The Employee identification Number or Tax Identification Number of the business. | |
relatedPersons | list of objects | | |
firstName | string | The first name of the individual. | |
middlesName | string | The middle name of the individual. | |
lastName | string | The last name of the individual. | |
title | string | The title of the related person. | |
registrationFiling | string | | |
date | string | The date of the registration filing. | |
registrationType | string | The type of registration. | |
region | string | The state or locality of the business registration. | |
identityId | string | A unique ID that Prove generates to refer to a specific identity. | |
verifyResult | string | The result of the Verify process. Possible values are success , pending , and failed . If the Verify result is pending , clients will need to call the Verify Status API to get a result. | |
possessionResult | string | The result of the possession check. Possible values are pending and not_applicable , based on the possessionType passed in the input. Clients will have to call the Verify Status API to get a result if possessionResult=pending . | |
success | string | The result of the combination of verifyResult and possessionResult . Possible values are true , pending , and false . The value will be pending until the results of both Verify and Possession are returned or one of them fails, blocking the other. | |
allowOTPRetry | boolean | If true, the customer can re-enter the OTP up to three times. Code must also be implemented. See client-side SDK guide for more details. | |