Skip to content
AcrivaDocs

CheckInDocument

POST
/api/v1/t/{tenant}/documents/{documentId}/check-in
curl --request POST \
  --url https://example.com/api/v1/t/example/documents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/check-in

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

documentId
required
string format: uuid

Responses

Section titled “ Responses ”

201

Section titled “201”

Created

Media typeapplication/json
object
version
required
object
number
required
integer format: int32
sha256
required
string
size
required
integer format: int64
contentType
required
string
fileName
required
string
createdBy
required
string format: uuid
createdAt
required
string format: date-time
processingState
required
Allowed values: Pending Clean Quarantined Processed Failed
quarantinedAt
required
null | string format: date-time
renditions
required
Array<object>
object
kind
required
Allowed values: PdfA EInvoiceView ValidationReport SignatureProtocol SignatureAuditTrail
generation
required
integer format: int32
contentType
required
string
size
required
integer format: int64
createdAt
required
string format: date-time
recognitionStartedAt
required
null | string format: date-time
endedWithoutPdfA
required
boolean
duplicates
required
Array<object>
object
documentId
required
string format: uuid
title
required
string
versionNumber
required
integer format: int32
Example
{
  "version": {
    "processingState": "Pending",
    "renditions": [
      {
        "kind": "PdfA"
      }
    ]
  }
}

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “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

Section titled “404”

Not Found

409

Section titled “409”

Conflict

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

413

Section titled “413”

Payload Too Large

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

415

Section titled “415”

Unsupported Media Type

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

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