Learn about the components that make up the Prove Identity Manager solution
Field | Field Type | Enroll Identity | Description |
---|---|---|---|
phoneNumber | string | Required | The number of the mobile phone. Acceptable characters are: alphanumeric with symbols ’+’. |
phoneNumber (date last verified) | string | The last date that a possession check was completed for a phone number. The format is YYYY-MM-DD . Acceptable characters are: numeric with symbol ’-‘ | |
verificationType | string | Prove offers different verification methods based on your use case and authorization level required. Available verification methods are: bot verifiedUsers prefill prefillForBusiness accountOpening identityResolution | |
firstName | string | Required | The verified first name of the user. |
lastName | string | Required | The verified last name of the user. |
emailAddress | string | Optional | The email address associated with the phone number. |
email (date last verified) | string | Optional | The date the email address was last verified (e.g., 2023-01-01 ). |
address | list object | Optional | A list of up to three verified addresses for the user, each containing street , street2 , city , region , and postalCode . |
street | string | Optional | The street address of the individual. |
extendedAddress (street2) | string | Optional | The apartment number or other extended address information. |
city | string | Optional | The city of the individual. |
region | string | Optional | The state or locality of the individual. |
postalCode | string | Optional | The zip code of the individual. It can be either 5 digits (XXXXX ) or ZIP+4 (XXXXX-XXXX ). |
dateOfbirth | string | Optional | The date of birth associated with the phone number. |
nationalId | string | Optional | The user’s national ID, such as the full or last four digits of their SSN. |
ipAddress | string | Optional | The IP address of the user. |
deviceId | string | Optional | A string that is the unique identifier for the Prove Key on the device. Only applicable if you are leveraging Prove Unified Authentication. |
correlationId | string | A unique ID that links all calls for the same flow. This is a crucial field to save for subsequent calls. | |
clientRequestId | string | Optional | Your unique request identifier. |
clientCustomerId | string | Optional | 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. |
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. |
Field | Field Type | Enroll Identity |
---|---|---|
success | boolean | ✅ |
phoneNumber | string | |
verifyResult (GFP Result) | string | ✅ |
assuranceLevel | string | ✅ |
correlationId | string | ✅ |
proveId | string | ✅ |
proveKey | string | ✅ |
identityId | string | ✅ |
clientRequestID | string | |
clientHumanID | string | |
clientCustomerId | string | |
identity | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email(s) | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string | |
reasons | list of objects | |
additionalIdentities | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string |
Field | Field Type | Batch Enroll Identity | Description |
---|---|---|---|
phoneNumber | string | Required | The number of the mobile phone. Acceptable characters are: alphanumeric with symbols ’+’. |
phoneNumber (date last verified) | string | The last date that a possession check was completed for a phone number. The format is YYYY-MM-DD . Acceptable characters are: numeric with symbol ’-‘ | |
verificationType | string | Prove offers different verification methods based on your use case and authorization level required. Available verification methods are: bot verifiedUsers prefill prefillForBusiness accountOpening identityResolution | |
firstName | string | Required | The verified first name of the user. |
lastName | string | Required | The verified last name of the user. |
emailAddress | string | Optional | The email address associated with the phone number. |
email (date last verified) | string | Optional | The date the email address was last verified (e.g., 2023-01-01 ). |
address | list object | Optional | A list of up to three verified addresses for the user, each containing street , street2 , city , region , and postalCode . |
street | string | Optional | The street address of the individual. |
extendedAddress (street2) | string | Optional | The apartment number or other extended address information. |
city | string | Optional | The city of the individual. |
region | string | Optional | The state or locality of the individual. |
postalCode | string | Optional | The zip code of the individual. It can be either 5 digits (XXXXX ) or ZIP+4 (XXXXX-XXXX ). |
dateOfbirth | string | Optional | The date of birth associated with the phone number. |
nationalId | string | Optional | The user’s national ID, such as the full or last four digits of their SSN. |
ipAddress | string | Optional | The IP address of the user. |
deviceId | string | Optional | A string that is the unique identifier for the Prove Key on the device. Only applicable if you are leveraging Prove Unified Authentication. |
correlationId | string | A unique ID that links all calls for the same flow. This is a crucial field to save for subsequent calls. | |
clientRequestId | string | Optional | Your unique request identifier. |
clientCustomerId | string | Optional | 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. |
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. |
Field | Field Type | Enroll Identity |
---|---|---|
error | string | ✅ |
phoneNumber | string | |
verifyResult (GFP Result) | string | ✅ |
assuranceLevel | string | ✅ |
correlationId | string | ✅ |
proveId | string | ✅ |
proveKey | string | ✅ |
identityId | string | ✅ |
clientRequestID | string | |
clientHumanID | string | |
clientCustomerId | string | |
identity | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email(s) | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string | |
reasons | list of objects | |
additionalIdentities | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string |
Field | Field Type | Get Identity | Description |
---|---|---|---|
phoneNumber | string | Optional | The number of the mobile phone. Acceptable characters are: alphanumeric with symbols ’+’. |
phoneNumber (date last verified) | string | The last date that a possession check was completed for a phone number. The format is YYYY-MM-DD . Acceptable characters are: numeric with symbol ’-‘ | |
verificationType | string | Prove offers different verification methods based on your use case and authorization level required. Available verification methods are: bot verifiedUsers prefill prefillForBusiness accountOpening identityResolution | |
firstName | string | The verified first name of the user. | |
lastName | string | The verified last name of the user. | |
emailAddress | string | The email address associated with the phone number. | |
email (date last verified) | string | The date the email address was last verified (e.g., 2023-01-01 ). | |
address | list object | A list of up to three verified addresses for the user, each containing street , street2 , city , region , and postalCode . | |
street | string | The street address of the individual. | |
extendedAddress (street2) | 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. | |
postalCode | string | The zip code of the individual. It can be either 5 digits (XXXXX ) or ZIP+4 (XXXXX-XXXX ). | |
dateOfbirth | string | The date of birth associated with the phone number. | |
nationalId | string | The user’s national ID, such as the full or last four digits of their SSN. | |
ipAddress | string | The IP address of the user. | |
deviceId | string | A string that is the unique identifier for the Prove Key on the device. Only applicable if you are leveraging Prove Unified Authentication. | |
identityId | string | Required | A unique Prove-generated identifier for the enrolled identity. |
correlationId | string | A unique ID that links all calls for the same flow. This is a crucial field to save for subsequent calls. | |
clientRequestId | string | Optional | Your unique request identifier. |
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. | |
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. |
Field | Field Type | Enroll Identity |
---|---|---|
success | boolean | |
phoneNumber | string | ✅ |
verifyResult (GFP Result) | string | ✅ |
assuranceLevel | string | ✅ |
correlationId | string | ✅ |
proveId | string | ✅ |
proveKey | string | ✅ |
identityId | string | ✅ |
deviceId | string | ✅ |
active | boolean | ✅ |
carrier | string | ✅ |
lineType | string | ✅ |
countryCode | string | ✅ |
createdAt | integer | ✅ |
creationString | string | ✅ |
clientRequestID | string | |
clientHumanID | string | |
clientCustomerId | string | ✅ |
identity | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email(s) | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string | |
reasons | list of objects | |
additionalIdentities | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string |
Field | Field Type | Get Identity | Description |
---|---|---|---|
phoneNumber | string | Required | The number of the mobile phone. Acceptable characters are: alphanumeric with symbols ’+’. |
phoneNumber (date last verified) | string | The last date that a possession check was completed for a phone number. The format is YYYY-MM-DD . Acceptable characters are: numeric with symbol ’-‘ | |
verificationType | string | Prove offers different verification methods based on your use case and authorization level required. Available verification methods are: bot verifiedUsers prefill prefillForBusiness accountOpening identityResolution | |
firstName | string | The verified first name of the user. | |
lastName | string | The verified last name of the user. | |
emailAddress | string | The email address associated with the phone number. | |
email (date last verified) | string | The date the email address was last verified (e.g., 2023-01-01 ). | |
address | list object | A list of up to three verified addresses for the user, each containing street , street2 , city , region , and postalCode . | |
street | string | The street address of the individual. | |
extendedAddress (street2) | 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. | |
postalCode | string | The zip code of the individual. It can be either 5 digits (XXXXX ) or ZIP+4 (XXXXX-XXXX ). | |
dateOfbirth | string | The date of birth associated with the phone number. | |
nationalId | string | The user’s national ID, such as the full or last four digits of their SSN. | |
ipAddress | string | The IP address of the user. | |
deviceId | string | A string that is the unique identifier for the Prove Key on the device. Only applicable if you are leveraging Prove Unified Authentication. | |
identityId | string | A unique Prove-generated identifier for the enrolled identity. | |
correlationId | string | A unique ID that links all calls for the same flow. This is a crucial field to save for subsequent calls. | |
clientRequestId | string | Optional | Your unique request identifier. |
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. | |
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. |
Field | Field Type | Enroll Identity |
---|---|---|
success | boolean | |
phoneNumber | string | ✅ |
verifyResult (GFP Result) | string | ✅ |
assuranceLevel | string | ✅ |
correlationId | string | ✅ |
proveId | string | ✅ |
proveKey | string | ✅ |
identityId | string | ✅ |
deviceId | string | ✅ |
active | boolean | ✅ |
carrier | string | ✅ |
lineType | string | ✅ |
countryCode | string | ✅ |
createdAt | integer | ✅ |
creationString | string | ✅ |
clientRequestID | string | |
clientHumanID | string | |
clientCustomerId | string | ✅ |
identity | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email(s) | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string | |
reasons | list of objects | |
additionalIdentities | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string |
Field | Field Type | Get Identity | Description |
---|---|---|---|
phoneNumber | string | The number of the mobile phone. Acceptable characters are: alphanumeric with symbols ’+’. | |
phoneNumber (date last verified) | string | The last date that a possession check was completed for a phone number. The format is YYYY-MM-DD . Acceptable characters are: numeric with symbol ’-‘ | |
verificationType | string | Prove offers different verification methods based on your use case and authorization level required. Available verification methods are: bot verifiedUsers prefill prefillForBusiness accountOpening identityResolution | |
firstName | string | The verified first name of the user. | |
lastName | string | The verified last name of the user. | |
emailAddress | string | The email address associated with the phone number. | |
email (date last verified) | string | The date the email address was last verified (e.g., 2023-01-01 ). | |
address | list object | A list of up to three verified addresses for the user, each containing street , street2 , city , region , and postalCode . | |
street | string | The street address of the individual. | |
extendedAddress (street2) | 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. | |
postalCode | string | The zip code of the individual. It can be either 5 digits (XXXXX ) or ZIP+4 (XXXXX-XXXX ). | |
dateOfbirth | string | The date of birth associated with the phone number. | |
nationalId | string | The user’s national ID, such as the full or last four digits of their SSN. | |
ipAddress | string | The IP address of the user. | |
deviceId | string | A string that is the unique identifier for the Prove Key on the device. Only applicable if you are leveraging Prove Unified Authentication. | |
identityId | string | Required | A unique Prove-generated identifier for the enrolled identity. |
correlationId | string | A unique ID that links all calls for the same flow. This is a crucial field to save for subsequent calls. | |
clientRequestId | string | Optional | Your unique request identifier. |
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. | |
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. |
Field | Field Type | Enroll Identity |
---|---|---|
success | boolean | ✅ |
phoneNumber | string | |
verifyResult (GFP Result) | string | |
assuranceLevel | string | |
correlationId | string | |
proveId | string | |
proveKey | string | |
identityId | string | |
deviceId | string | |
active | boolean | |
carrier | string | |
lineType | string | |
countryCode | string | |
createdAt | integer | |
creationString | string | |
clientRequestID | string | |
clientHumanID | string | |
clientCustomerId | string | |
identity | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email(s) | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string | |
reasons | list of objects | |
additionalIdentities | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string |
Field | Field Type | Get Identity | Description |
---|---|---|---|
phoneNumber | string | The number of the mobile phone. Acceptable characters are: alphanumeric with symbols ’+’. | |
phoneNumber (date last verified) | string | The last date that a possession check was completed for a phone number. The format is YYYY-MM-DD . Acceptable characters are: numeric with symbol ’-‘ | |
verificationType | string | Prove offers different verification methods based on your use case and authorization level required. Available verification methods are: bot verifiedUsers prefill prefillForBusiness accountOpening identityResolution | |
firstName | string | The verified first name of the user. | |
lastName | string | The verified last name of the user. | |
emailAddress | string | The email address associated with the phone number. | |
email (date last verified) | string | The date the email address was last verified (e.g., 2023-01-01 ). | |
address | list object | A list of up to three verified addresses for the user, each containing street , street2 , city , region , and postalCode . | |
street | string | The street address of the individual. | |
extendedAddress (street2) | 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. | |
postalCode | string | The zip code of the individual. It can be either 5 digits (XXXXX ) or ZIP+4 (XXXXX-XXXX ). | |
dateOfbirth | string | The date of birth associated with the phone number. | |
nationalId | string | The user’s national ID, such as the full or last four digits of their SSN. | |
ipAddress | string | The IP address of the user. | |
deviceId | string | A string that is the unique identifier for the Prove Key on the device. Only applicable if you are leveraging Prove Unified Authentication. | |
identityId | string | Required | A unique Prove-generated identifier for the enrolled identity. |
correlationId | string | A unique ID that links all calls for the same flow. This is a crucial field to save for subsequent calls. | |
clientRequestId | string | Optional | Your unique request identifier. |
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. | |
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. |
Field | Field Type | Enroll Identity |
---|---|---|
success | boolean | ✅ |
phoneNumber | string | |
verifyResult (GFP Result) | string | |
assuranceLevel | string | |
correlationId | string | |
proveId | string | |
proveKey | string | |
identityId | string | |
deviceId | string | |
active | boolean | |
carrier | string | |
lineType | string | |
countryCode | string | |
createdAt | integer | |
creationString | string | |
clientRequestID | string | |
clientHumanID | string | |
clientCustomerId | string | |
identity | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email(s) | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string | |
reasons | list of objects | |
additionalIdentities | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string |
Field | Field Type | Get Identity | Description |
---|---|---|---|
phoneNumber | string | The number of the mobile phone. Acceptable characters are: alphanumeric with symbols ’+’. | |
phoneNumber (date last verified) | string | The last date that a possession check was completed for a phone number. The format is YYYY-MM-DD . Acceptable characters are: numeric with symbol ’-‘ | |
verificationType | string | Prove offers different verification methods based on your use case and authorization level required. Available verification methods are: bot verifiedUsers prefill prefillForBusiness accountOpening identityResolution | |
firstName | string | The verified first name of the user. | |
lastName | string | The verified last name of the user. | |
emailAddress | string | The email address associated with the phone number. | |
email (date last verified) | string | The date the email address was last verified (e.g., 2023-01-01 ). | |
address | list object | A list of up to three verified addresses for the user, each containing street , street2 , city , region , and postalCode . | |
street | string | The street address of the individual. | |
extendedAddress (street2) | 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. | |
postalCode | string | The zip code of the individual. It can be either 5 digits (XXXXX ) or ZIP+4 (XXXXX-XXXX ). | |
dateOfbirth | string | The date of birth associated with the phone number. | |
nationalId | string | The user’s national ID, such as the full or last four digits of their SSN. | |
ipAddress | string | The IP address of the user. | |
deviceId | string | A string that is the unique identifier for the Prove Key on the device. Only applicable if you are leveraging Prove Unified Authentication. | |
identityId | string | A unique Prove-generated identifier for the enrolled identity. | |
correlationId | string | A unique ID that links all calls for the same flow. This is a crucial field to save for subsequent calls. | |
clientRequestId | string | Your unique request identifier. | |
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. | |
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. |
Field | Field Type | Enroll Identity |
---|---|---|
success | boolean | |
phoneNumber | string | |
verifyResult (GFP Result) | string | |
assuranceLevel | string | |
correlationId | string | |
proveId | string | |
proveKey | string | |
identityId | string | ✅ |
deviceId | string | |
active | boolean | |
carrier | string | |
lineType | string | |
countryCode | string | |
createdAt | integer | |
creationString | string | |
clientRequestID | string | ✅ |
clientHumanID | string | |
clientCustomerId | string | |
identity | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email(s) | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string | |
reasons | list of objects | |
additionalIdentities | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string |
Field | Field Type | Enroll Identity |
---|---|---|
success | boolean | |
phoneNumber | string | |
verifyResult (GFP Result) | string | |
assuranceLevel | string | |
correlationId | string | |
proveId | string | |
proveKey | string | |
identityId | string | ✅ |
deviceId | string | |
active | boolean | |
carrier | string | |
lineType | string | |
countryCode | string | |
createdAt | integer | |
creationString | string | |
clientRequestID | string | |
eventId | string | ✅ |
event | string | ✅ |
eventType | string | ✅ |
eventTimestamp | string | ✅ |
clientHumanID | string | |
clientCustomerId | string | ✅ |
identity | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email(s) | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string | |
reasons | list of objects | |
additionalIdentities | list of objects | |
firstName | string | |
lastName | string | |
nationalId | string | |
dateOfBirth | string | |
email | list of objects | |
email1 | string | |
email2 | string | |
address(es) | list of objects | |
streetAddress | string | |
streetAddress2 | string | |
city | string | |
region | string | |
zipCode | string |