> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# IdentityCheck API reference

> API reference for IdentityCheck: every `identitycheck.api.*` operation with input and output types.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Verification

### create

`verification.create`

Start an individual verification; it uses plan credit, and with emailUser "Yes" StackGo emails the person an invitation

**Risk:** `destructive`

```ts theme={null}
await corsair.identitycheck.api.verification.create({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `Record<string, any>` | Yes | Request body sent to StackGo as-is. StackGo has not published the field list; its quickstart uses firstName, lastName, email, emailUser ("Yes" emails the person an invitation), type (e.g. "kyc"), triggeredBy ("direct") and active (true). |

**Output:** `Record<string, any>`

***

### get

`verification.get`

Retrieve a verification and result

**Risk:** `read`

```ts theme={null}
await corsair.identitycheck.api.verification.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |

**Output:** `Record<string, any>`

***

### image

`verification.image`

Download a document or selfie image captured during a verification (needs the verification.image key scope)

**Risk:** `read`

```ts theme={null}
await corsair.identitycheck.api.verification.image({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `verificationId` | `string` | Yes | ID of the verification the image belongs to |
| `imageId` | `string` | Yes | ID of the captured document or selfie image |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `contentBase64` | `string` | No | The file, base64-encoded. Missing when the file came back as text or contentOmitted is set. |
| `text` | `string` | No | The file as text, in place of contentBase64, when it is a text file (CSV, JSON, Markdown, XML and the like) in UTF-8. |
| `contentType` | `string` | Yes | Media type of the file, for example application/pdf. |
| `byteLength` | `number` | Yes | Size of the file in bytes. |
| `filename` | `string` | No | The file name, when known. |
| `contentOmitted` | `not_requested \| over_limit` | No | Set when the content was left out: the caller did not ask for it, or the file was over the limit. |

***

### kyb

`verification.kyb`

Start a business KYB check; it uses plan credit

**Risk:** `destructive`

```ts theme={null}
await corsair.identitycheck.api.verification.kyb({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `Record<string, any>` | Yes | Request body sent to StackGo as-is. StackGo has not published the field list; its quickstart uses firstName, lastName, email, emailUser ("Yes" emails the person an invitation), type (e.g. "kyc"), triggeredBy ("direct") and active (true). |

**Output:** `Record<string, any>`

***

### sms

`verification.sms`

Start a verification and invite the person by SMS; it uses plan credit

**Risk:** `destructive`

```ts theme={null}
await corsair.identitycheck.api.verification.sms({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `Record<string, any>` | Yes | Request body sent to StackGo as-is. StackGo has not published the field list; its quickstart uses firstName, lastName, email, emailUser ("Yes" emails the person an invitation), type (e.g. "kyc"), triggeredBy ("direct") and active (true). |

**Output:** `Record<string, any>`

***

### tranche2

`verification.tranche2`

Start a Tranche 2 workflow; it uses plan credit

**Risk:** `destructive`

```ts theme={null}
await corsair.identitycheck.api.verification.tranche2({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `body` | `Record<string, any>` | Yes | Request body sent to StackGo as-is. StackGo has not published the field list; its quickstart uses firstName, lastName, email, emailUser ("Yes" emails the person an invitation), type (e.g. "kyc"), triggeredBy ("direct") and active (true). |

**Output:** `Record<string, any>`

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.