---
title: "Check access"
---

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

Path: Sureshake API › vault

`POST /v2/vault/access/check`

## Request body

_Required._

- `collectionId` (`vault-check-access.collectionId`; string, required)
  - format `uuid`
- `walletAddress` (`vault-check-access.walletAddress`; string, required)
  - pattern `^0x[a-fA-F0-9]{40}$`
- `documentId` (`vault-check-access.documentId`; string, optional)
  - format `uuid`

## Example request

```json
{
  "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50",
  "walletAddress": "string",
  "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url https://api.sureshake.com/v2/vault/access/check \
  --header 'Content-Type: application/json' \
  --data '
{
  "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50",
  "walletAddress": "string",
  "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052"
}
'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/vault/access/check';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    collectionId: '0ffe69e2-b7af-4b1e-835c-867376165f50',
    walletAddress: 'string',
    documentId: '4704590c-004e-410d-adf7-acb7ca0a7052'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/vault/access/check"

payload = {
    "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50",
    "walletAddress": "string",
    "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "hasAccess": true,
    "tokenType": "access",
    "expiresAt": "2019-08-24T14:15:22Z",
    "policyVersion": 0,
    "checkedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`vault-check-access.response.200.data`; object, required)
  - `hasAccess` (`vault-check-access.response.200.data.hasAccess`; boolean, required)
  - `tokenType` (`vault-check-access.response.200.data.tokenType`; string, required, nullable)
    - one of `"access"`, `"auditor"`, `"regulator"`
  - `expiresAt` (`vault-check-access.response.200.data.expiresAt`; string, required, nullable)
    - format `date-time`
  - `policyVersion` (`vault-check-access.response.200.data.policyVersion`; number, required)
  - `checkedAt` (`vault-check-access.response.200.data.checkedAt`; string, required)
    - format `date-time`
- `meta` (`vault-check-access.response.200.meta`; object, optional)
  - `timestamp` (`vault-check-access.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`vault-check-access.response.400.error`; object, required)
  - `code` (`vault-check-access.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`vault-check-access.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`vault-check-access.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`vault-check-access.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`vault-check-access.response.401.error`; object, required)
  - `code` (`vault-check-access.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`vault-check-access.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`vault-check-access.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`vault-check-access.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`vault-check-access.response.403.error`; object, required)
  - `code` (`vault-check-access.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`vault-check-access.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`vault-check-access.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`vault-check-access.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`vault-check-access.response.500.error`; object, required)
  - `code` (`vault-check-access.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`vault-check-access.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`vault-check-access.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`vault-check-access.response.500.error.traceId`; string, optional) — Unique ID for log correlation

### 503

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`vault-check-access.response.503.error`; object, required)
  - `code` (`vault-check-access.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`vault-check-access.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`vault-check-access.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`vault-check-access.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/vault-check-access/index.md