COcounselhealth
/v1/user

Mark a user's identity as verified

Marks the user's identity as verified — a one-time transition from unverified to verified. Your organization must be granted the capability to assert identity verification via the API; contact Counsel support to enable it.

Include the verified demographics — first_name, last_name, and dob — from the completed identity check. Optionally include middle_name.

On success, the response is verification_status: "verified" with id_verified: true.

On a mismatch, the response is verification_status: "mismatch" with id_verified: false

The call is idempotent: if the user is already verified, the request succeeds without changing the existing verification record. Verification cannot be reverted through this API.

post/v1/user/{userId}/verifyIdentity/

Request

  • Base URL
    https://api.counselhealth.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

userIdstring required

Headers

Idempotency-Keystring
Example:550e8400-e29b-41d4-a716-446655440000

Optional idempotency key. Repeat requests with the same key and body return the original result.

Request body

status'verified' required
first_namestring required
middle_namestring
last_namestring required
dobstring required

date of birth in YYYY-MM-DD format (ISO 8601). Must be between 18 and 120 years old

referencestring

Example request

{
  "dob": "1990-01-01"
}

Response

Default Response

OR

Changes

No recorded changes to this operation across all 1 revision of this API.