Request a one-time code
POST
/api/v1/sign/{token}/request-otp
const url = 'https://sign-api.binarybridges.co/api/v1/sign/example/request-otp';const options = {method: 'POST'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://sign-api.binarybridges.co/api/v1/sign/example/request-otpOnly for envelopes configured with otpRequired. Inside the resend cooldown this returns the challenge already delivered rather than issuing a new one, so a signer who reloads keeps the code they were sent.
Parameters
Sección titulada «Parameters»Path Parameters
Sección titulada «Path Parameters»token
required
string
Responses
Sección titulada «Responses»OK
Media type*/*
object
challengeId
string format: uuid
codeUnusable
required
boolean
expiresInSeconds
required
integer format: int64
message
required
string
resendAvailableInSeconds
required
integer format: int64
resent
required
boolean
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"}The resource is not in a state that allows this — for example sending an envelope that is already sent.
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"}A domain rule rejected the request.
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"}An organisation quota is exhausted.
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"}