Create an identity verification session

Creates or resumes an identity verification session and returns a URL that can be used to launch the verification flow.

If you do not have an active verification session, a new one will be created. If a session is already in progress, the API returns the existing session details, allowing you to resume your progress.

If CallbackUrl is provided, you are redirected to that exact URL upon completion.
If CallbackUrl is not provided, you will be redirected to the impact.com platform.

Parameters

`UserId` integer required

Your unique impact.com identifier. Refer to List all users to retrieve your UserId using the Users endpoint.

`CallbackUrl` string optional

The URL you should be redirected to after completing the verification session.

Returns

If the UserId does not exist or the authentication credentials are invalid, the API returns a standard error structure. See the Errors page.

Example request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/IdentityVerification/Session' \
  -X POST \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Content-Type: application/json' \
  -d '{
    "UserId": 12345,
    "CallbackUrl": "https://example.com/verification-complete"
  }'

Example response

{
  "ImpactRadiusResponse": {
    "Status": "OK",
    "Uri": "/Mediapartners/<AccountSID>/IdentityVerification/Session/3",
    "id": "3",
    "sessionId": "17e6b3c6-a27f-4067-a48f-2d1d4c885e39",
    "sessionUrl": "https://verification.impact.com/v/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.EXAMPLE_DATA_TOKEN_STUB",
    "memberId": "12345"
  }
}