KAkalixa

Returns a list of entities with missing and assigned documents.

Returns a list of entities with missing and assigned documents.

get/entity-required-documents

Request

  • Base URL
    https://api.test.kalixa.com/payment-service/v6
  • URL
    https://api.test.kalixa.com/payment-service/v6/entity-required-documents
  • Auth
    HTTP basic

Query parameters

entityIdstring required

The id of the entity to check for required documents. Can be the identifier of a Merchant, RelatedPerson, RelatedCompany, Shop or BankAccount.

status'missing' | 'assigned'

The information if documents with status missing, assigned or both should be returned. If not provided, the response will contain both assigned and missing documents.

includeChildrenboolean

The information if required documents for related entities should be included in the response (true) or not (false). If not provided, the default value is 'true'.

Response

Successful operation

Example response

{
  "items": [
    {
      "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290",
      "requiredDocuments": [
        {
          "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.