Zum Inhalt springen
AcrivaDocs

ListDocumentSignatures

GET
/api/v1/t/{tenant}/signatures/requests
curl --request GET \
  --url 'https://example.com/api/v1/t/example/signatures/requests?documentId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Parameters

Abschnitt betitelt „ Parameters “

Path Parameters

Abschnitt betitelt „Path Parameters“
tenant
required
string

Tenant slug

Query Parameters

Abschnitt betitelt „Query Parameters“
documentId
required
string format: uuid

Responses

Abschnitt betitelt „ Responses “

200

Abschnitt betitelt „200“

OK

Media typeapplication/json
Array<object>
object
requestId
required
string format: uuid
versionNumber
required
integer format: int32
state
required
Allowed values: Preparing Review Open Signed Declined Expired Cancelled Failed
level
required
Allowed values: Ses Aes Qes
method
required
Allowed values: Acriva Provider
createdAt
required
string format: date-time
sentAt
required
null | string format: date-time
expiresAt
required
string format: date-time
endedAt
required
null | string format: date-time
signedVersionNumber
required
null | integer format: int32
hasProtocol
required
boolean
signers
required
Array<object>
object
position
required
integer format: int32
label
required
string
kind
required
Allowed values: Member Requester External
state
required
Allowed values: Waiting Invited Signed Declined Expired Cancelled
name
required
null | string
invitedAt
required
null | string format: date-time
endedAt
required
null | string format: date-time
canResend
required
boolean
failureReason
required
null | string
Example
[
  {
    "state": "Preparing",
    "level": "Ses",
    "method": "Acriva",
    "signers": [
      {
        "kind": "Member",
        "state": "Waiting"
      }
    ]
  }
]

403

Abschnitt betitelt „403“

Forbidden

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"
}

404

Abschnitt betitelt „404“

Not Found

429

Abschnitt betitelt „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"
}