Request a scoped third-party Forecast attestation

POST

https://api.sureshake.com/v2/entities/{entityId}/calls/{callId}/attestations

Path parameters

entityId
required
Any of the following:
string
string
}

callId
string
required
format: uuid

Request body JSON required

invitedEmail
string
required
format: email · maxLength: 320
relationship
customer
or
advisor
or
operator
or
capital_provider
or
other
required

Returns

201

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- callId
  string
  required
  format: uuid
- invitedEmail
  string
  required
  format: email
- relationship
  customer
  or
  advisor
  or
  operator
  or
  capital_provider
  or
  other
  required
- status
  pending
  or
  attested
  or
  revoked
  or
  expired
  required
- observed
  string
  or null
  required
- notVerified
  string
  or null
  required
- eventId
  string
  or null
  required
  format: uuid
- expiresAt
  string
  required
  format: date-time
- attestedAt
  string
  or null
  required
  format: date-time
- createdAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Request a scoped third-party Forecast attestation

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"
}
'

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));

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)

Response example

{
  "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"
  }
}

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

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

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

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

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

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

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