Create a signing link
POST/signature/links
Create a signing link for an active document. Costs credits.
Both customer_id and contact_id are required. The customer is the business
the document belongs to; the contact is the person who will sign it — and a
signed document that cannot say who signed it is not worth much.
Safe to retry. Calling this twice for the same document and contact returns
the existing link instead of creating a second one, and does not charge again.
created in the response tells you which happened, and the status code follows
it (201 for a new link, 200 for an existing one).
Request
Responses
- 200
- 201
- 400
- 401
- 402
- 403
- 404
An existing pending link was returned. Nothing was charged.
Signing link created.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
The request was malformed, or a parameter was rejected.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No token, an expired token, or a credential that has been revoked.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
A plan ceiling or a locked feature stopped an otherwise valid request.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
Refused. Either the credential does not hold the scope this endpoint needs (code: insufficient_scope), or the account's IP allow-list does not include the calling address (code: ip_not_allowed).
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No such resource in this account.
Response Headers
Correlation id for this request. Quote it when reporting a problem.