Docs
API referencePeople and H R

Send documents for signature

Preview· P9
POST
/signing-requests

Sends up to ten PDFs to up to 25 signers, in order or together. Someone in your directory signs in Agoo; anyone else gets a one-time link by email, SMS or both, chosen for this message. New files are checked for viruses before anyone is asked. When everyone has signed, Agoo seals each PDF with a certificate page and a QR code, and fires signing.completed.

Authorization

headerAuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people.
agoo_pk_test_Publishable key, test modeAs above, in test mode
agoo_rk_live_Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews BusinessYour servers only: the Reviews operations, for that business and the branches the key names
agoo_rk_test_Agoo Reviews key, test modeAs above, on any level: it reads the business's reviews and checks every write without saving it
agoo_ck_live_Check API key, live mode, for a Check API partnerYour servers only: the Checks operations (checks:read), billed per check
agoo_ck_test_Check API key, test modeAs above, answering only the published test values, never billed

Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers; a Check API partner creates its keys in its partner area on agoo.reviews. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.

Scope: signing:write

Request Body

application/json
  1. body
documents*array<>|
Items1 <= items <= 10
expires_days?integer

How long it stays open. Default: your signing settings' (14 days).

Formatint64
Range1 <= value <= 90
message?string
Lengthlength <= 500
order?string
Value in"in_order""together"
person_id?string

Whose documents the sealed PDF joins.

Match^person_[0-7][0-9a-hjkmnp-tv-z]{25}$
signers*array<>|
Items1 <= items <= 25
title*string
Length1 <= length <= 160
type_id?string

What kind of document it files as, with person_id.

Match^hrdoctype_[0-7][0-9a-hjkmnp-tv-z]{25}$

Response Body

Created

application/json
  1. response
completed_at?string
Formatdate-time
created_at*string
Formatdate-time
declined_at?string
Formatdate-time
documents*array<>|null
events?array<>|null
expires_at*string
Formatdate-time
id*string
message?string
order*string
person?string
person_id?string
sender?string
sent_at?string
Formatdate-time
signers*array<>|null
source_kind*string
status*string
Value in"checking""sent""sealing""completed""declined""voided""expired"
title*string
type_id?string
version*integer
Formatint64
visibility*string
void_reason?string
voided_at?string
Formatdate-time
curl -X POST 'https://api.agoohq.com/v1/signing-requests' \  -H 'Content-Type: application/json' \  -d '{  "documents": [    {}  ],  "signers": [    {}  ],  "title": "string"}'
{  "completed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "declined_at": "2019-08-24T14:15:22Z",  "documents": [    {      "byte_size": 0,      "hr_document_id": "string",      "id": "string",      "pages": 0,      "position": 0,      "sealed": true,      "sealed_byte_size": 0,      "sha256": "string",      "status": "string",      "title": "string",      "verify": null    }  ],  "events": [    {      "property1": null,      "property2": null    }  ],  "expires_at": "2019-08-24T14:15:22Z",  "id": "string",  "message": "string",  "order": "string",  "person": "string",  "person_id": "string",  "sender": "string",  "sent_at": "2019-08-24T14:15:22Z",  "signers": [    {      "asked_at": "2019-08-24T14:15:22Z",      "by_link": true,      "channels": [        "string"      ],      "contact": "string",      "decline_reason": "string",      "id": "string",      "last_reminded_at": "2019-08-24T14:15:22Z",      "method": "string",      "name": "string",      "person_id": "string",      "placements": null,      "position": 0,      "role": "string",      "signed_at": "2019-08-24T14:15:22Z",      "status": "string",      "viewed_at": "2019-08-24T14:15:22Z"    }  ],  "source_kind": "string",  "status": "checking",  "title": "string",  "type_id": "string",  "version": 0,  "visibility": "string",  "void_reason": "string",  "voided_at": "2019-08-24T14:15:22Z"}