Open a signing link
GET
/api/v1/sign/{token}
const url = 'https://sign-api.binarybridges.co/api/v1/sign/example';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://sign-api.binarybridges.co/api/v1/sign/exampleThe signer’s entry point. Returns the envelope, its documents and whether an OTP is required. Unauthenticated — the token in the path IS the credential.
Parameters
Sección titulada «Parameters»Path Parameters
Sección titulada «Path Parameters»token
required
string
Responses
Sección titulada «Responses»OK
Media type*/*
object
alreadySigned
required
boolean
documents
required
Array<object>
object
downloadUrl
required
string
filename
required
string
id
required
string format: uuid
envelopeId
required
string format: uuid
envelopeTitle
required
string
requiresOtp
required
boolean
signerEmail
required
string
signerName
required
string
The request was malformed or failed validation.
Media typeapplication/json
object
code
required
string
error
required
string
message
required
string
path
required
string
quota
object
current
required
integer format: int64
dimension
required
string
limit
required
integer format: int64
status
required
integer format: int32
timestamp
required
string format: date-time
traceId
string
Example generated
{ "code": "example", "error": "example", "message": "example", "path": "example", "quota": { "current": 1, "dimension": "example", "limit": 1 }, "status": 1, "timestamp": "2026-04-15T12:00:00Z", "traceId": "example"}No such resource, or it belongs to another organisation. Deliberately not a 403: a 403 across a tenant boundary confirms the id exists.
Media typeapplication/json
object
code
required
string
error
required
string
message
required
string
path
required
string
quota
object
current
required
integer format: int64
dimension
required
string
limit
required
integer format: int64
status
required
integer format: int32
timestamp
required
string format: date-time
traceId
string
Example generated
{ "code": "example", "error": "example", "message": "example", "path": "example", "quota": { "current": 1, "dimension": "example", "limit": 1 }, "status": 1, "timestamp": "2026-04-15T12:00:00Z", "traceId": "example"}