> ## Documentation Index > Fetch the complete documentation index at: https://docs.mycreditapp.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get the completeness of the document type required for the analytics > Get document completeness status for analytics. #### [Authorization scenarios](/content/developer-guide/introduction/authorization#scenarios) | Guest | Host | Self | |-------|------|------| | ❌ | ❌ | ✅ | ## OpenAPI ````yaml /content/developer-guide/api-reference/openapi_v1.json get /private-records/{record_id}/documents/completeness openapi: 3.1.0 info: title: API - V1 version: 1.0.0 servers: - url: https://api.mycreditapp.ai/v1-beta security: [] paths: /private-records/{record_id}/documents/completeness: get: tags: - Private Record Documents summary: Get the completeness of the document type required for the analytics description: |- Get document completeness status for analytics. #### [Authorization scenarios](/content/developer-guide/introduction/authorization#scenarios) | Guest | Host | Self | |-------|------|------| | ❌ | ❌ | ✅ | operationId: >- get_documents_completeness_for_analytics_private_records__record_id__documents_completeness_get parameters: - name: record_id in: path required: true schema: type: string format: uuid description: >- Unique identifier of the [private record](https://docs.mycreditapp.ai/api-reference/private-records/get-private-records) examples: - b25e7b65-e46a-40d5-a0f2-0de8c2b354aa title: Record Id description: >- Unique identifier of the [private record](https://docs.mycreditapp.ai/api-reference/private-records/get-private-records) - name: Requester-Organization-ID in: header required: true schema: type: string format: uuid description: | The unique identifier of the organization making the request. **This ID is used to authorize the requester within the system**. examples: - 054b4106-174b-46b0-97f8-86d8d7b6f0af title: Requester-Organization-Id description: | The unique identifier of the organization making the request. **This ID is used to authorize the requester within the system**. - name: Target-Organization-ID in: header required: true schema: type: string format: uuid description: > The unique identifier of the organization that is the target of the request. The `Target-Organization-ID` may match the `Requester-Organization-ID` if the requester accesses their own resources. If the `Target-Organization-ID` differs from the `Requester-Organization-ID`, the requester can access third-party resources **if the requester has a connection with the target organization and is authorized to perform such actions**. examples: - 123e4567-e89b-12d3-a456-426614174000 title: Target-Organization-Id description: > The unique identifier of the organization that is the target of the request. The `Target-Organization-ID` may match the `Requester-Organization-ID` if the requester accesses their own resources. If the `Target-Organization-ID` differs from the `Requester-Organization-ID`, the requester can access third-party resources **if the requester has a connection with the target organization and is authorized to perform such actions**. responses: '200': description: Successful Response content: application/json: schema: $ref: >- #/components/schemas/src__api__private_records_documents__models__DocumentRequirements '400': description: Bad Request content: application/json: example: detail: - loc: [] msg: Unsupported CRUD operation! type: request code: unsupported_crud_operation schema: $ref: '#/components/schemas/APIError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/APIError' example: detail: - loc: [] msg: Token is required! type: token code: token_required - loc: [] msg: The token has expired! type: token code: token_expired - loc: [] msg: Invalid token! type: token code: invalid_token '403': description: Forbidden content: application/json: example: detail: - loc: [] msg: Access denied! type: request code: access_denied schema: $ref: '#/components/schemas/APIError' '404': description: Not Found content: application/json: example: detail: - loc: [] msg: Account not found! type: request code: account_not_found - loc: [] msg: Organization not found! type: request code: organization_not_found schema: $ref: '#/components/schemas/APIError' '409': description: Conflict content: application/json: example: detail: - loc: [] msg: >- The account is in the process of being deleted! The Account's email can only be reused after its data has been completely deleted. The removal process may take up to 24 hours. type: request code: account_being_deleted - loc: [] msg: >- The organization is in the process of being deleted! The removal process may take up to 24 hours. type: request code: organization_being_deleted schema: $ref: '#/components/schemas/APIError' '413': description: Request Entity Too Large content: application/json: schema: $ref: '#/components/schemas/APIError' example: detail: - loc: [] msg: The request is too large! type: request code: request_too_large '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/APIError' example: detail: - loc: - string - 0 msg: string type: string code: validation_error '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/APIError' example: detail: - loc: [] msg: Error processing request, please try later! type: try_later code: internal_conflict_error '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/APIError' example: detail: - loc: [] msg: Service is under maintenance, please try later! type: maintanance code: service_under_maintenance security: - Token: [] components: schemas: src__api__private_records_documents__models__DocumentRequirements: properties: balance_sheet: $ref: '#/components/schemas/DocumentRequirementItems' description: Requirements status for balance sheet documents income_statement: $ref: '#/components/schemas/DocumentRequirementItems' description: Requirements status for income statement documents cashflow_statement: $ref: '#/components/schemas/DocumentRequirementItems' description: Requirements status for cash flow statement documents type: object required: - balance_sheet - income_statement - cashflow_statement title: DocumentRequirements APIError: properties: detail: items: $ref: '#/components/schemas/ErrorItem' type: array title: Detail description: > List of returned errors. **All unsuccessful error codes except code `422` can only contain 1 element in the list**. type: object required: - detail title: APIError DocumentRequirementItems: properties: required: items: $ref: '#/components/schemas/DocumentPeriod' type: array title: Required description: List of required document periods filled: items: $ref: '#/components/schemas/DocumentPeriod' type: array title: Filled description: List of document periods that have been submitted missing: items: $ref: '#/components/schemas/DocumentPeriod' type: array title: Missing description: List of document periods that are still missing optional: items: $ref: '#/components/schemas/DocumentPeriod' type: array title: Optional description: List of optional periods that are not required but can be submitted type: object required: - required - filled - missing - optional title: DocumentRequirementItems ErrorItem: properties: loc: items: anyOf: - type: string - type: integer type: array title: Loc description: | Shows the dynamic location of the current error. If an empty array is returned, the error is static. examples: - - body - date_field - 0 - - header - Authorization msg: type: string title: Msg description: | A human-readable message providing more details about the error. examples: - Token is required! - Invalid token! type: type: string title: Type description: > A string indicating the type of error. **The list is not fixed, so it's necessary to pay attention to the possible type for a specific error**. examples: - token - request - try_later code: type: string title: Code description: > Unique text error code identifying the error. **The list is not fixed, so it's necessary to pay attention to the possible code for a specific error**. examples: - token_required - invalid_token - access_denied type: object required: - loc - msg - type - code title: ErrorItem DocumentPeriod: properties: year: type: integer title: Year description: Year of the reporting period examples: - 2024 - 2025 month: type: integer maximum: 12 minimum: 1 title: Month description: Month of the reporting period (1-12) examples: - 1 - 6 - 12 type: object required: - year - month title: DocumentPeriod securitySchemes: Token: type: http description: >- [Bearer authentication](/content/developer-guide/introduction/authentication) using a JWT token. Provide a valid access token. Authorization header format: `Authorization: Bearer `. scheme: bearer ````