---
title: "Read Identity Review"
method: GET
path: "/setup/company-profile/review"
tags: ["setup"]
---

# Read Identity Review

`GET /setup/company-profile/review`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/setup/company-profile/review`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Headers

- `organization-id` string, nullable
- `x-user-id` string, nullable
- `timezone` string
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- IdentityReviewPublic
  - `is_mock` boolean
  - `state` 'not_requested' | 'queued' | 'paused' | 'reviewing' | 'held' | 'approved' | 'rejected' | 'needs_review', required
  - `reason_code` union
    - 'account_setup_required' | 'requester_required' | 'staff_review_required' | 'provider_setup_required' | 'ambiguous_provider_operation' | 'retry_exhausted'
    - 'confirmation_required'
  - `observed_at` string, date-time, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/cce8b07a5787?raw)