Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
API ReferenceAccount and accessOrganizations

Add a note to a live verification hold

Adds a statement (company, use case, link) to the org's live verification hold for the reviewer; it gives context and never lifts the hold itself. Answers 409 when the org has no active hold, or already holds the maximum number of notes.

Required permission

Requires the org.signal permission. See Permissions for the roles and API key permissions that include it.

POST
/v1/orgs/{id}/verification-note

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

id*string

Request Body

application/json
  1. body
company?string
Lengthlength <= 160
useCase?string

The only field a reviewer needs; required in practice (empty fails 400).

Lengthlength <= 1500
link?string
Lengthlength <= 300

Response Body

Created

application/json
  1. response
received*boolean
Example Request
curl -X POST 'https://api.openrelay.inc/v1/orgs/string/verification-note' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "received": true}