Skip to main content

Individual document statuses

This method allows retrieving documents’ statuses by their unique IDs.

Query params​

keyrequiredone or more integer

A documents’ unique ID on the business online.

GET api/documents/statuses/{keys}

Response​

UniqueIdglobally unique identifier

An unique ID of the document in the external (caller) system (Guid).

UniqueKeyinteger

An unique ID of the document in the business online.

Statusstring

A document status.

BulkLineStatusstring

Is used during package transfers.

RejectCodeinteger

A rejection code.

ResultCodeinteger

A result code of an operation. ResultCode.

Matchdecimal number

For the internal transfers a matched coefficient of provided recipient name. For legal entities a match of an owner of a provided IBAN to the entity name is being checked, while for the individuals - to the name and surname. A match coefficient in percent will be shown as a result of such a comparison.

[
  {
    "UniqueId": "79d46ee2-2150-4fc0-b0b6-d22ea3476551",
    "UniqueKey": 1,
    "Status": "sample string 2",
    "BulkLineStatus": "sample string 3",
    "RejectCode": 1,
    "ResultCode": 1,
    "Match": 1.0
  },
  {
    "UniqueId": "79d46ee2-2150-4fc0-b0b6-d22ea3476551",
    "UniqueKey": 1,
    "Status": "sample string 2",
    "BulkLineStatus": "sample string 3",
    "RejectCode": 1,
    "ResultCode": 1,
    "Match": 1.0
  }
]