Skip to main content
POST
/
v3
/
identity
csharp
using Prove.Proveapi;
using Prove.Proveapi.Models.Components;

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

V3EnrollIdentityRequest req = new V3EnrollIdentityRequest() {
    ClientCustomerId = "e0f78bc2-f748-4eda-9d29-d756844507fc",
    ClientRequestId = "71010d88-d0e7-4a24-9297-d1be6fefde81",
    DeviceId = "bf9ea15d-7dfa-4bb4-a64c-6c26b53472fc",
    PhoneNumber = "2001001695",
};

var res = await sdk.Identity.V3EnrollIdentityAsync(req);

// handle response
{
  "identityId": "863189q5-5555-4c15-89ba-15d08710aecz",
  "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

Request body for the V3 Enroll Identity API.

​
phoneNumber
string
required

The number of the consumer being enrolled. US phone numbers can be passed in with or without a leading +1. Acceptable characters are: alphanumeric with symbols '+'.

Example:

"2001001695"

​
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. 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:

"e0f78bc2-f748-4eda-9d29-d756844507fc"

​
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

A string that is the unique identifier for the Prove Key on the device. Only applicable if you are leveraging Prove Unify.

Example:

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

Response

V3EnrollIdentityResponse

Response body for the V3 Enroll Identity method.

​
identityId
string
required

A unique Prove-generated identifier for the enrolled identity. This is a UUID that can be used to reference the identity in future requests.

Example:

"863189q5-5555-4c15-89ba-15d08710aecz"

​
success
boolean
required

If true, the request was successful and the identity was created.

Example:

true