Activate Identity

using Prove.Proveapi;
using Prove.Proveapi.Models.Components;

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

var res = await sdk.Identity.V3ActivateIdentityAsync(
    identityId: "<id>",
    v3ActivateIdentityRequest: new Prove.Proveapi.Models.Components.V3ActivateIdentityRequest() {
        ClientRequestId = "71010d88-d0e7-4a24-9297-d1be6fefde81",
    }
);

// handle response

{
  "success": true
}

POST

identity

{identityId}

activate

using Prove.Proveapi;
using Prove.Proveapi.Models.Components;

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

var res = await sdk.Identity.V3ActivateIdentityAsync(
    identityId: "<id>",
    v3ActivateIdentityRequest: new Prove.Proveapi.Models.Components.V3ActivateIdentityRequest() {
        ClientRequestId = "71010d88-d0e7-4a24-9297-d1be6fefde81",
    }
);

// handle response

{
  "success": true
}

Authorizations

Authorization

string

header

required

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

Path Parameters

identityId

string

required

A Prove-generated unique ID for a specific identity.

Body

application/json

Request body for the V3 Activate Identity 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"

Response

V3ActivateIdentityResponse

Response body for the V3 Activate Identity API.

success

boolean

required

If true, the activate operation was successful.

Example:

true

⌘I