---
name: identity-routes
description: Handle 8 OpenAPI operation(s) under /v1/identity for the identity route group.
---

# identity API Routes

Handle 8 OpenAPI operation(s) under /v1/identity for the identity route group.

Use the generated operation tools to make real API calls. Do not invent API responses.
If a tool reports missing setup, return the exact setup field name to the caller.
For write, update, or delete operations, state the intended action before calling the tool.

## Operations

### get_identity_verification_reports

- Operation ID: `get_identity_verification_reports`
- Route: `GET /v1/identity/verification_reports`
- Mode: READ
- Summary: List VerificationReports
- Parameters:
  - `client_reference_id` in `query`
  - `created` in `query`
  - `ending_before` in `query`
  - `expand` in `query`
  - `limit` in `query`
  - `starting_after` in `query`
  - `type` in `query`
  - `verification_session` in `query`
- Body: JSON request body accepted.

### get_identity_verification_reports_report

- Operation ID: `get_identity_verification_reports_report`
- Route: `GET /v1/identity/verification_reports/{report}`
- Mode: READ
- Summary: Retrieve a VerificationReport
- Parameters:
  - `expand` in `query`
  - `report` in `path` required
- Body: JSON request body accepted.

### get_identity_verification_sessions

- Operation ID: `get_identity_verification_sessions`
- Route: `GET /v1/identity/verification_sessions`
- Mode: READ
- Summary: List VerificationSessions
- Parameters:
  - `client_reference_id` in `query`
  - `created` in `query`
  - `ending_before` in `query`
  - `expand` in `query`
  - `limit` in `query`
  - `related_customer` in `query`
  - `related_customer_account` in `query`
  - `starting_after` in `query`
  - `status` in `query`
- Body: JSON request body accepted.

### post_identity_verification_sessions

- Operation ID: `post_identity_verification_sessions`
- Route: `POST /v1/identity/verification_sessions`
- Mode: WRITE
- Summary: Create a VerificationSession
- Body: JSON request body accepted.

### get_identity_verification_sessions_session

- Operation ID: `get_identity_verification_sessions_session`
- Route: `GET /v1/identity/verification_sessions/{session}`
- Mode: READ
- Summary: Retrieve a VerificationSession
- Parameters:
  - `expand` in `query`
  - `session` in `path` required
- Body: JSON request body accepted.

### post_identity_verification_sessions_session

- Operation ID: `post_identity_verification_sessions_session`
- Route: `POST /v1/identity/verification_sessions/{session}`
- Mode: WRITE
- Summary: Update a VerificationSession
- Parameters:
  - `session` in `path` required
- Body: JSON request body accepted.

### post_identity_verification_sessions_session_cancel

- Operation ID: `post_identity_verification_sessions_session_cancel`
- Route: `POST /v1/identity/verification_sessions/{session}/cancel`
- Mode: WRITE
- Summary: Cancel a VerificationSession
- Parameters:
  - `session` in `path` required
- Body: JSON request body accepted.

### post_identity_verification_sessions_session_redact

- Operation ID: `post_identity_verification_sessions_session_redact`
- Route: `POST /v1/identity/verification_sessions/{session}/redact`
- Mode: WRITE
- Summary: Redact a VerificationSession
- Parameters:
  - `session` in `path` required
- Body: JSON request body accepted.
