---
title: "Request a scoped third-party Forecast attestation"
---

> 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 › predictions

`POST /v2/entities/{entityId}/calls/{callId}/attestations`

## Path parameters

- `entityId` (`predictions-request-attestation.path.entityId`; any of, required)
  - any of: `string`, `string`
- `callId` (`predictions-request-attestation.path.callId`; string, required)
  - format `uuid`

## Request body

_Required._

- `invitedEmail` (`predictions-request-attestation.invitedEmail`; string, required)
  - format `email`; maxLength 320
- `relationship` (`predictions-request-attestation.relationship`; string, required)
  - one of `"customer"`, `"advisor"`, `"operator"`, `"capital_provider"`, `"other"`

## Example request

```json
{
  "invitedEmail": "user@example.com",
  "relationship": "customer"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url 'https://api.sureshake.com/v2/entities/<entityId>/calls/<callId>/attestations' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invitedEmail": "user@example.com",
  "relationship": "customer"
}
'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/entities/<entityId>/calls/<callId>/attestations';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({invitedEmail: 'user@example.com', relationship: 'customer'})
};

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/entities/<entityId>/calls/<callId>/attestations"

payload = {
    "invitedEmail": "user@example.com",
    "relationship": "customer"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
```

## Responses

### 201

Default Response

#### Example

```json
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "callId": "4722cd84-0ec7-4ef5-8c34-1b0150f45f53",
    "invitedEmail": "user@example.com",
    "relationship": "customer",
    "status": "pending",
    "observed": "string",
    "notVerified": "string",
    "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",
    "expiresAt": "2019-08-24T14:15:22Z",
    "attestedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`predictions-request-attestation.response.201.data`; object, required)
  - `id` (`predictions-request-attestation.response.201.data.id`; string, required)
    - format `uuid`
  - `callId` (`predictions-request-attestation.response.201.data.callId`; string, required)
    - format `uuid`
  - `invitedEmail` (`predictions-request-attestation.response.201.data.invitedEmail`; string, required)
    - format `email`
  - `relationship` (`predictions-request-attestation.response.201.data.relationship`; string, required)
    - one of `"customer"`, `"advisor"`, `"operator"`, `"capital_provider"`, `"other"`
  - `status` (`predictions-request-attestation.response.201.data.status`; string, required)
    - one of `"pending"`, `"attested"`, `"revoked"`, `"expired"`
  - `observed` (`predictions-request-attestation.response.201.data.observed`; string, required, nullable)
  - `notVerified` (`predictions-request-attestation.response.201.data.notVerified`; string, required, nullable)
  - `eventId` (`predictions-request-attestation.response.201.data.eventId`; string, required, nullable)
    - format `uuid`
  - `expiresAt` (`predictions-request-attestation.response.201.data.expiresAt`; string, required)
    - format `date-time`
  - `attestedAt` (`predictions-request-attestation.response.201.data.attestedAt`; string, required, nullable)
    - format `date-time`
  - `createdAt` (`predictions-request-attestation.response.201.data.createdAt`; string, required)
    - format `date-time`
- `meta` (`predictions-request-attestation.response.201.meta`; object, optional)
  - `timestamp` (`predictions-request-attestation.response.201.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

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

- `error` (`predictions-request-attestation.response.400.error`; object, required)
  - `code` (`predictions-request-attestation.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`predictions-request-attestation.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`predictions-request-attestation.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`predictions-request-attestation.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` (`predictions-request-attestation.response.401.error`; object, required)
  - `code` (`predictions-request-attestation.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`predictions-request-attestation.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`predictions-request-attestation.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`predictions-request-attestation.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` (`predictions-request-attestation.response.403.error`; object, required)
  - `code` (`predictions-request-attestation.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`predictions-request-attestation.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`predictions-request-attestation.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`predictions-request-attestation.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

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

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

### 409

Default Response

#### Example

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

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

### 500

Default Response

#### Example

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

- `error` (`predictions-request-attestation.response.500.error`; object, required)
  - `code` (`predictions-request-attestation.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`predictions-request-attestation.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`predictions-request-attestation.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`predictions-request-attestation.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` (`predictions-request-attestation.response.503.error`; object, required)
  - `code` (`predictions-request-attestation.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`predictions-request-attestation.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`predictions-request-attestation.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`predictions-request-attestation.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/predictions-request-attestation/index.md