Skip to main content
POST
/
v3
/
unify-status
C#
using Prove.Proveapi;
using Prove.Proveapi.Models.Components;

var sdk = new ProveAPI(auth: "<YOUR_AUTH_HERE>");

V3UnifyStatusRequest req = new V3UnifyStatusRequest() {
    ClientRequestId = "71010d88-d0e7-4a24-9297-d1be6fefde81",
    CorrelationId = "713189b8-5555-4b08-83ba-75d08780aebd",
    PhoneNumber = "2001004011",
};

var res = await sdk.V3.V3UnifyStatusRequestAsync(req);

// handle response
{
  "success": true,
  "proveId": "a07b94ce-218c-461f-beda-d92480e40f61",
  "phoneNumber": "2001004011",
  "clientHumanId": "7bfbb91d-9df8-4ec0-99a6-de05ecc23a9e",
  "clientRequestId": "71010d88-d0e7-4a24-9297-d1be6fefde81",
  "deviceId": "bf9ea15d-7dfa-4bb4-a64c-6c26b53472fc",
  "evaluation": {
    "authentication": {
      "result": "pass"
    },
    "identification": {
      "result": "pass"
    },
    "success": true
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the /token endpoint. Refer to the Authentication page for more details.

Body

application/json
​
correlationId
string
required

The unique ID that Prove generates for the flow. It is returned from the v3/unify endpoint and cannot be reused outside of a single flow.

Example:

"713189b8-5555-4b08-83ba-75d08780aebd"

​
clientRequestId
string

A client-generated unique ID for a specific session. This can be used to identify specific requests. 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.

Example:

"71010d88-d0e7-4a24-9297-d1be6fefde81"

​
phoneNumber
string

The mobile phone number. US phone numbers can be passed in with or without a leading +1. International phone numbers require a leading +1. Use the appropriate endpoint URL based on the region the number originates from. Acceptable characters are: alphanumeric with symbols '+'. Required when possessionType=none in the initial Unify request.

Required except when MobileAuth is used in US or a valid ProveID is provided.

Example:

"2001004011"

Response

Successful Request.

​
success
string
required

The result of the possession check. Possible values are true, false, pending, and possession_required.

Example:

"true"

​
clientHumanId
string

A client-generated unique ID to identify a specific customer across business lines. Required if success=true.

Example:

"7bfbb91d-9df8-4ec0-99a6-de05ecc23a9e"

​
clientRequestId
string

A client-generated unique ID for a specific session. This can be used to identify specific requests. 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.

Example:

"71010d88-d0e7-4a24-9297-d1be6fefde81"

​
deviceId
string

The unique identifier for the Prove Key on the device.

Example:

"bf9ea15d-7dfa-4bb4-a64c-6c26b53472fc"

​
evaluation
object

The evaluation result for the policy. This will contain keys titled "authentication" and "identification" that encompass the different evaluation categories.

Example:
{
  "authentication": { "result": "pass" },
  "identification": { "result": "pass" }
}
​
phoneNumber
string

The number of the mobile phone used during the process.

Example:

"2001004011"

​
proveId
string

A unique ID to identify a specific customer obtained from a successful possession check. If an existing value is available (e.g. from a previous successful possession check) then it should be returned, otherwise a new value should be generated if success=true.

Example:

"a07b94ce-218c-461f-beda-d92480e40f61"