---
title: "Returns a list of entities with missing and assigned documents."
method: GET
path: "/entity-required-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

Returns a list of entities with missing and assigned documents.

## Query parameters

- `entityId` string, required
- `status` 'missing' | 'assigned'
- `includeChildren` boolean

## Response `200`

Successful operation

- object
  - `items` EntityRequiredDocuments[]: A list of entities with missing and assigned documents.
    - `id` string: The id of the entity.
    - `type` 'Merchant' | 'RelatedPerson' | 'RelatedCompany' | 'Shop' | 'BankAccount': The type of the entity.
    - `requiredDocuments` object[]: A list of document types with missing or assigned documents.
      - `id` string: The id of the document if the status is assigned. If the status is missing, the id will be empty.
      - `type` 'AddressProofForMerchantLocation' | 'AnnualReport' | 'ArticlesOfAssociation' | 'BankReferenceLetter' | 'BankStatement' | 'BusinessLicenseOrAuthorization' | 'CardProcessingHistory6Months' | 'CertificationOfIncorporation' | 'ChargebackAndFraudPolicyAndProcedures' | 'CompanyAMLPolicyAndGuidelines' | 'Contract' | 'ExternalRiskChecksResult' | 'ExternalCompanyRiskChecksResult' | 'ExternalCustomerRiskChecksResult' | 'LegalOpinion' | 'Organogram' | 'PassportOrGovernmentID' | 'PCIQuarterlyASVReport' | 'PCIReportOnCompliance' | 'PCISelfAssessmentQuestionnaire' | 'PersonalUtilityBill' | 'ProofOfAuthorisedSignatory' | 'ProofOfDomainOwnership' | 'TaxFilings': The type of the document.
      - `status` 'Missing' | 'Assigned': The information if the document is missing or assigned.

## Other responses

- `400`: Error occurred

---

[API](https://skmtc.dev/kalixa/apis/payment-service-v6-merchant-onboarding.md) - [All operations](https://skmtc.dev/kalixa/apis/payment-service-v6-merchant-onboarding/llms.txt) - [OpenAPI document](https://skmtc.dev/kalixa/apis/payment-service-v6-merchant-onboarding/revisions/066120f66046?raw)