Skip to content
AcrivaDocs

GetPublicSigning

GET
/api/v1/public/signing
curl --request GET \
  --url https://example.com/api/v1/public/signing

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
tenantName
required
string
documentTitle
required
string
maskedEmail
required
string
requestState
required
Allowed values: Preparing Review Open Signed Declined Expired Cancelled Failed
signerState
required
Allowed values: Waiting Invited Signed Declined Expired Cancelled
language
required
string
expiresAt
required
string format: date-time
codeSent
required
boolean
verified
required
boolean
placeRequired
required
boolean
fields
required
Array<object> | null
object
page
required
integer format: int32
x
required
number format: double
y
required
number format: double
width
required
number format: double
height
required
number format: double
kind
required
Allowed values: Signature Date Text
purpose
required
One of:
null
Example
{
  "requestState": "Preparing",
  "signerState": "Waiting",
  "fields": [
    {
      "kind": "Signature",
      "purpose": "Name"
    }
  ]
}

404

Section titled “404”

Not Found

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}