Individual document status

This method allows retrieving a document status by its unique ID.

Query params

keyrequiredinteger

A document unique ID on the business online.

REQUEST

GET api/documents/status/{key}

Response

UniqueIdglobally unique identifier

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

UniqueKeyinteger

A 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. result code

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.

JSON

{
  "UniqueId": "11cca9ac-1a45-413b-a86a-d491f33f3668",
  "UniqueKey": 1,
  "Status": "sample string 2",
  "BulkLineStatus": "sample string 3",
  "RejectCode": 1,
  "ResultCode": 1,
  "Match": 1.0
}

XML

<DocumentStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CIBApi.Models">
  <BulkLineStatus>sample string 3</BulkLineStatus>
  <Match>1</Match>
  <RejectCode>1</RejectCode>
  <ResultCode>1</ResultCode>
  <Status>sample string 2</Status>
  <UniqueId>11cca9ac-1a45-413b-a86a-d491f33f3668</UniqueId>
  <UniqueKey>1</UniqueKey>
</DocumentStatus>