Identity Verification

Endpoint for creating and resuming identity verification sessions.

Create or Resume an Identity Verification Session

post

Creates a new identity verification session or resumes an existing one. Returns a URL that can be used to launch the hosted verification flow. If a session is already in progress for the specified user, the existing session details are returned so verification can resume from where it left off.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Body

application/json

UserIdintegerRequired

The unique numeric identifier of the impact.com user to verify. This is the numeric portion of the user's ID (e.g. for user I-5402850, pass 5402850).

Example: 5402850

CallbackUrlstringOptional

The URL to redirect the user to after the verification session completes. If omitted, the user is redirected to the impact.com platform.

Example: https://example.com/verification/callback

Responses

200

The identity verification session object.

application/json

StatusstringOptional

The status of the API response (e.g., OK).

Example: OK

UristringOptional

API resource path for this identity verification session.

Example: /Mediapartners/<AccountSID>/IdentityVerification/Session/48944

idstringOptional

The unique identifier for this identity verification session.

Example: 48944

sessionIdstringOptional

A UUID that uniquely identifies the verification session with the identity verification provider.

Example: d9d96e4e-1b79-45b5-bfb4-44864b896aa6

sessionUrlstringOptional

The URL to redirect the user to in order to complete the identity verification flow.

Example: https://verification.impact.com/v/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.EXAMPLE_TOKEN

memberIdstringOptional

The numeric portion of the impact.com user ID associated with this session.

Example: 5402850

400

Validation error or the supplied UserId is not accessible for the partner account.

application/json

401

Unauthorized — invalid authentication credentials.

application/json

post/Mediapartners/{AccountSID}/IdentityVerification/Session

HTTPcURLJavaScriptPython

POST /Mediapartners/{AccountSID}/IdentityVerification/Session HTTP/1.1
Host: api.impact.com
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "UserId": 5402850,
  "CallbackUrl": "https://example.com/verification/callback"
}

{
  "Status": "OK",
  "Uri": "/Mediapartners/<AccountSID>/IdentityVerification/Session/48944",
  "id": "48944",
  "sessionId": "d9d96e4e-1b79-45b5-bfb4-44864b896aa6",
  "sessionUrl": "https://verification.impact.com/v/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.EXAMPLE_TOKEN",
  "memberId": "5402850"
}