Document expiration

{
  "scanRef": "<string>",
  "clientId": "<string>",
  "expirationThreshold": "DOCUMENT_EXPIRES_WITHIN_30_DAYS",
  "documentExpiration": "<string>"
}

WEBHOOK

documentExpiration

{
  "scanRef": "<string>",
  "clientId": "<string>",
  "expirationThreshold": "DOCUMENT_EXPIRES_WITHIN_30_DAYS",
  "documentExpiration": "<string>"
}

Idenfy-Event-Type

enum<string>

required

Available options:

DOCUMENT_EXPIRATION

Idenfy-Signature

string

Webhook signature

application/json

scanRef

string

required

clientId

string

required

expirationThreshold

enum<string>

required

Available options:

DOCUMENT_EXPIRES_WITHIN_30_DAYS,

DOCUMENT_EXPIRES_WITHIN_7_DAYS,

DOCUMENT_EXPIRES_WITHIN_1_DAY,

DOCUMENT_EXPIRED

documentExpiration

string

required

200

Return a 200 status to indicate that the data was received successfully.

⌘I