# Package transfer status

This method allows retrieving the status of a document package and all individual documents status by a package unique ID.

## Query params

- `key` — integer, required

  An unique ID of the document in the business online..

**REQUEST**

```api
GET api/documents/bulk/status/{key}
```

## Response

- `Status` — string

  A document status.

- `DocumentStatuses` — string

  A document array from a package transfer with the following attributes:

  - `UniqueId ` — globally unique identifier

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

  - `UniqueKey ` — integer

    An unique ID of the document in the business online.

  - `Status` — string

    A document status.

  - `BulkLineStatus` — string

    Is used in case of the package transfer.

  - `RejectCode` — string

    A rejection code.

  - `ResultCode` — integer

    A result code of an operation. (With a link to the ResultCode page).

  - `Match` — integer

    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**

```json
{
  "Status": "sample string 1",
  "DocumentStatuses": [
    {
      "UniqueId": "54079737-2913-48d5-a0ed-f22895c33116",
      "UniqueKey": 1,
      "Status": "sample string 2",
      "BulkLineStatus": "sample string 3",
      "RejectCode": 1,
      "ResultCode": 1,
      "Match": 1.0
    },
    {
      "UniqueId": "54079737-2913-48d5-a0ed-f22895c33116",
      "UniqueKey": 1,
      "Status": "sample string 2",
      "BulkLineStatus": "sample string 3",
      "RejectCode": 1,
      "ResultCode": 1,
      "Match": 1.0
    }
  ]
}
```

**xml**

```xml
<BulkPaymentStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CIBApi.Models">
  <DocumentStatuses>
    <DocumentStatus>
      <BulkLineStatus>sample string 3</BulkLineStatus>
      <Match>1</Match>
      <RejectCode>1</RejectCode>
      <ResultCode>1</ResultCode>
      <Status>sample string 2</Status>
      <UniqueId>54079737-2913-48d5-a0ed-f22895c33116</UniqueId>
      <UniqueKey>1</UniqueKey>
    </DocumentStatus>
    <DocumentStatus>
      <BulkLineStatus>sample string 3</BulkLineStatus>
      <Match>1</Match>
      <RejectCode>1</RejectCode>
      <ResultCode>1</ResultCode>
      <Status>sample string 2</Status>
      <UniqueId>54079737-2913-48d5-a0ed-f22895c33116</UniqueId>
      <UniqueKey>1</UniqueKey>
    </DocumentStatus>
  </DocumentStatuses>
  <Status>sample string 1</Status>
</BulkPaymentStatus>
```