Learn about the components that make up the Prove Unified Authentication solution
Field | Field Type | Unified Authentication | Description |
---|---|---|---|
phoneNumber or emailAddress | string | Required | The number of the mobile phone. Acceptable characters are: alphanumeric with symbols ’+’. OR The email address associated with the phone number. |
AllowOTPRetry | Optional | ||
IPAddress | Optional | The IP address of the user. | |
SMSMessage | Optional | A custom message to include in the SMS for the Instant Link or OTP. | |
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 | Optional | 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 | Account Opening |
---|---|---|
result (i.e. success, failure) | string | ✅ |
proveID | string | ✅ |
proveKey | string | ✅ |
reasons (GFP codes) | string | ✅ |