Sign in
InOrbit
Docs

API reference

Record an attestation

Have a token? Manage tokens in the console
POST
/v1/guardrails/attestations

Store an attestation about a document of the account: a signed envelope whose signature is verified against one of the platform's attestation keys before it is stored.

Needs scope decisions:write.

Authorization

bearer
headerAuthorizationBearer <token>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Request Body

iohr.guardrails.v1.RecordAttestationRequest; path variables override their fields

application/json
  1. body

iohr.guardrails.v1.RecordAttestationRequest

account_id?string
envelope?string

Response Body

iohr.guardrails.v1.RecordAttestationResponse

application/json
  1. response

iohr.guardrails.v1.RecordAttestationResponse

attestation?

iohr.guardrails.v1.Attestation

import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  const { value } = await api.guardrails.recordAttestation({ envelope: "<envelope>" });  console.log(value);} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}

npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.

{  "attestation": {    "account_id": "string",    "attestation_id": "string",    "attested_at": "string",    "claims": 0,    "document_id": "string",    "envelope": "string",    "held": 0,    "key_id": "string",    "recorded_by": "string",    "statement": "string"  }}

Create or replace a policy PUT

Create or replace a policy by its name. Only a person who owns or administers the account, never an assistant. Audited by name. Needs scope `decisions:write`.

List attestations GET

A document's attestations, or the account's, newest first. Needs scope `decisions:read`.