Get a recipient

GET/recipients/get

Authorization

AuthorizationBearer token · headerrequired

Pass your API key as a Bearer token. API keys are scoped to specific operations — configure scopes in your organization's Settings → Developer → API Keys.

Query parameters

document_idstringrequired

idstringrequired

Responses

200

idstringrequired

emailstring<email>required

namestringrequired

roleRecipientRolerequired

signer — must provide a signature to complete the document
approver — must click Approve; no signature drawn
viewer — receives a copy but has no action required

Allowed:signerapproverviewer

statusRecipientStatusrequired

Allowed:pendingviewedsignedapproveddeclined

orderinteger

Position in sequential signing order

signed_atstring<date-time>

viewed_atstring<date-time>

declined_atstring<date-time>

decline_reasonstring

401

Missing or invalid API key

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

404

Resource not found

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

document_idquery*idquery*

Request

curl -X GET "https://api.seal.nyc/api/v1/recipients/get?document_id=string&id=string" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.seal.nyc/api/v1/recipients/get?document_id=string&id=string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.seal.nyc/api/v1/recipients/get?document_id=string&id=string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "id": "string",
  "email": "user@example.com",
  "name": "string",
  "role": "signer",
  "status": "pending",
  "order": 0,
  "signed_at": "2019-08-24T14:15:22Z",
  "viewed_at": "2019-08-24T14:15:22Z",
  "declined_at": "2019-08-24T14:15:22Z",
  "decline_reason": "string"
}

{
  "type": "AUTH_ERROR",
  "status": 401,
  "title": "Missing or invalid API key"
}

{
  "type": "NOT_FOUND",
  "status": 404,
  "title": "Document not found"
}