Skip to main content
POST
/
v3
/
identity
/
batch
C#
using Prove.Proveapi;
using Prove.Proveapi.Models.Components;
using System.Collections.Generic;

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

V3BatchEnrollIdentitiesRequest req = new V3BatchEnrollIdentitiesRequest() {
    ClientRequestId = "71010d88-d0e7-4a24-9297-d1be6fefde81",
    Items = new List<IdentityItem>() {
        new IdentityItem() {
            ClientName = "\"Client A\"",
            IdentityId = "\"e0f78bc2-f748-4eda-9d29-d756844507fc\"",
            Pcid = "\"12345\"",
        },
        new IdentityItem() {
            ClientName = "\"Client A\"",
            IdentityId = "\"e0f78bc2-f748-4eda-9d29-d756844507fc\"",
            Pcid = "\"12345\"",
        },
    },
};

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

// handle response
{
  "results": [
    {
      "identityId": "e0f78bc2-f748-4eda-9d29-d756844507fc"
    },
    {
      "error": "Invalid Phone Number"
    }
  ]
}

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 Batch Enroll Identities API.

​
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"

​
items
IdentityItem represents an identity item in the CrossDomainResponse. · object[]

Response

V3BatchEnrollIdentitiesResponse

Response body for the V3 Batch Enroll Identities API.

​
results
Batch Enroll Identities Result Item · object[]