openapi: 3.0.4 info: title: Mews Booking Engine API (Distributor) Account notes Identity documents API version: v1 description: The Mews Booking Engine API (historically the Distributor API, served from /api/distributor/v1) lets developers build guest-facing booking engines that create reservations directly in Mews. It exposes enterprise configuration, availability, pricing, products, vouchers, payment cards, and reservation group creation for front-end client consumption. x-generated-from: documentation x-source-url: https://api.mews.com/Swagger/distributor/swagger.json x-last-validated: '2026-06-02' servers: - url: https://api.mews.com description: Production - url: https://api.mews-demo.com description: Demo / sandbox security: - MewsClientToken: [] MewsAccessToken: [] tags: - name: Identity documents paths: /api/connector/v1/identityDocuments/getAll: post: tags: - Identity documents summary: Mews Get All Identity Documents description: Returns all identity documents for the specified customers, with additional filtering options available. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: identityDocuments_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/IdentityDocumentFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 IdentityDocumentIds: - e8a72a69-c20b-4278-b699-ab0400a32ecc - 24a3f051-49ed-411b-9384-78187f9daae6 CustomerIds: - fadd5bb6-b428-45d5-94f8-fd0d89fece6d - bccdafd1-3e44-439d-861f-341526b597a9 ChainIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 5fcd1933-22f2-40b9-84da-7db04cbecec2 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IdentityDocumentResult' example: IdentityDocuments: - Id: e8a72a69-c20b-4278-b699-ab0400a32ecc CustomerId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d Type: Passport Number: M1234567 ExpirationDate: '2040-10-24T00:00:00Z' IssuanceDate: '2024-10-24T00:00:00Z' IssuingCountryCode: CZ IssuingCountrySubdivisionCode: null IssuingCity: Prague IdentityDocumentSupportNumber: S-123456 - Id: cbe8a32e-3eb7-4226-baf4-69455a0eeaf4 CustomerId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d Type: IdentityCard Number: ID7654321 ExpirationDate: '2040-11-20T00:00:00Z' IssuanceDate: '2024-11-20T00:00:00Z' IssuingCountryCode: CZ IssuingCountrySubdivisionCode: null IssuingCity: Brno IdentityDocumentSupportNumber: B-321 Cursor: cbe8a32e-3eb7-4226-baf4-69455a0eeaf4 '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsGetAll400Example: summary: Default identityDocuments_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsGetAll401Example: summary: Default identityDocuments_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsGetAll403Example: summary: Default identityDocuments_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsGetAll408Example: summary: Default identityDocuments_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsGetAll204Example: summary: Default identityDocuments_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsGetAll429Example: summary: Default identityDocuments_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsGetAll500Example: summary: Default identityDocuments_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/connector/v1/identityDocuments/delete: post: tags: - Identity documents summary: Mews Delete Identity Documents description: Deletes specified identity documents. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: identityDocuments_delete requestBody: content: application/json: schema: $ref: '#/components/schemas/IdentityDocumentDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 IdentityDocumentIds: - e8a72a69-c20b-4278-b699-ab0400a32ecc - 2e1c6096-3a28-411d-a375-150a7350b278 ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: IdentityDocumentsDelete200Example: summary: Default identityDocuments_delete 200 response x-microcks-default: true value: {} '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsDelete400Example: summary: Default identityDocuments_delete 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsDelete401Example: summary: Default identityDocuments_delete 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsDelete403Example: summary: Default identityDocuments_delete 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsDelete408Example: summary: Default identityDocuments_delete 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsDelete204Example: summary: Default identityDocuments_delete 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsDelete429Example: summary: Default identityDocuments_delete 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsDelete500Example: summary: Default identityDocuments_delete 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/connector/v1/identityDocuments/clear: post: tags: - Identity documents summary: Mews Clear Identity Documents description: Deletes all identity documents for the specified customers. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: identityDocuments_clear requestBody: content: application/json: schema: $ref: '#/components/schemas/IdentityDocumentClearParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 CustomerIds: - fadd5bb6-b428-45d5-94f8-fd0d89fece6d - bccdafd1-3e44-439d-861f-341526b597a9 ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: IdentityDocumentsClear200Example: summary: Default identityDocuments_clear 200 response x-microcks-default: true value: {} '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsClear400Example: summary: Default identityDocuments_clear 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsClear401Example: summary: Default identityDocuments_clear 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsClear403Example: summary: Default identityDocuments_clear 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsClear408Example: summary: Default identityDocuments_clear 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsClear204Example: summary: Default identityDocuments_clear 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsClear429Example: summary: Default identityDocuments_clear 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsClear500Example: summary: Default identityDocuments_clear 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/connector/v1/identityDocuments/update: post: tags: - Identity documents summary: Mews Update Identity Documents description: Updates specified identity documents. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: identityDocuments_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleIdentityDocumentUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 IdentityDocuments: - Id: e8a72a69-c20b-4278-b699-ab0400a32ecc Type: Value: Passport Number: Value: '123456789' ExpirationDate: Value: '2040-11-20T00:00:00Z' IssuanceDate: Value: '2020-11-20T00:00:00Z' IssuingCountryCode: Value: CZ IssuingCity: Value: Prague IdentityDocumentSupportNumber: Value: S-123456 ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IdentityDocumentWriteResult' example: IdentityDocuments: - Id: e8a72a69-c20b-4278-b699-ab0400a32ecc CustomerId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d Type: Passport Number: M1234567 ExpirationDate: '2040-10-24T00:00:00Z' IssuanceDate: '2024-10-24T00:00:00Z' IssuingCountryCode: CZ IssuingCountrySubdivisionCode: null IssuingCity: Prague IdentityDocumentSupportNumber: S-123456 '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsUpdate400Example: summary: Default identityDocuments_update 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsUpdate401Example: summary: Default identityDocuments_update 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsUpdate403Example: summary: Default identityDocuments_update 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsUpdate408Example: summary: Default identityDocuments_update 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsUpdate204Example: summary: Default identityDocuments_update 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsUpdate429Example: summary: Default identityDocuments_update 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsUpdate500Example: summary: Default identityDocuments_update 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /api/connector/v1/identityDocuments/add: post: tags: - Identity documents summary: Mews Add Identity Documents description: Adds identity documents. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: identityDocuments_add requestBody: content: application/json: schema: $ref: '#/components/schemas/IdentityDocumentsAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 IdentityDocuments: - CustomerId: e8a72a69-c20b-4278-b699-ab0400a32ecc Type: Passport Number: '123456789' ExpirationDate: '2040-11-20T00:00:00Z' IssuanceDate: '2020-11-20T00:00:00Z' IssuingCountryCode: CZ IssuingCity: Prague IdentityDocumentSupportNumber: S-123456 ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IdentityDocumentWriteResult' example: IdentityDocuments: - Id: e8a72a69-c20b-4278-b699-ab0400a32ecc CustomerId: fadd5bb6-b428-45d5-94f8-fd0d89fece6d Type: Passport Number: M1234567 ExpirationDate: '2040-10-24T00:00:00Z' IssuanceDate: '2024-10-24T00:00:00Z' IssuingCountryCode: CZ IssuingCountrySubdivisionCode: null IssuingCity: Prague IdentityDocumentSupportNumber: S-123456 '400': description: Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsAdd400Example: summary: Default identityDocuments_add 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsAdd401Example: summary: Default identityDocuments_add 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsAdd403Example: summary: Default identityDocuments_add 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsAdd408Example: summary: Default identityDocuments_add 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsAdd204Example: summary: Default identityDocuments_add 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsAdd429Example: summary: Default identityDocuments_add 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' examples: IdentityDocumentsAdd500Example: summary: Default identityDocuments_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: ConnectorApiExceptionResult: title: ConnectorApiExceptionResult type: object properties: Message: type: string nullable: true example: string RequestId: type: string nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: nullable: true example: string additionalProperties: false x-schema-id: ConnectorApiExceptionResult IdentityDocumentTypeEnum: title: Document type enum: - IdentityCard - Passport - Visa - DriversLicense type: string description: ' IdentityCard Passport Visa DriversLicense' x-enumNames: - IdentityCard - Passport - Visa - DriversLicense x-enumDescriptions: - '' - '' - '' - '' Limitation: title: Limitation required: - Count type: object properties: Count: type: integer format: int32 example: 1 Cursor: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false description: Limitation on the quantity of data returned. x-schema-id: Limitation Unit: type: object additionalProperties: false IdentityDocumentUpdateParameters: title: Identity document update parameters required: - Id type: object properties: Id: type: string description: Unique identifier of the document. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Type: title: Identity document type update value allOf: - $ref: '#/components/schemas/IdentityDocumentTypeUpdateValue' description: Type of the document (or `null` if the type should not be updated). nullable: true example: string Number: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Number of the document (e.g. passport number or `null` if the number should not be updated). nullable: true example: '1001' ExpirationDate: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Expiration date in ISO 8601 format (or `null` if the expiration date should not be updated). format: date nullable: true example: '2026-06-02' IssuanceDate: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Date of issuance in ISO 8601 format (or `null` if the issuance date should not be updated). format: date nullable: true example: '2026-06-02' IssuingCountryCode: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: ISO 3166-1 code of the `Country` (or `null` if the issuing country code should not be updated). nullable: true example: string IssuingCountrySubdivisionCode: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Identifier of the country subdivision where the document was issued (province, state or region) (or `null` if the value should not be updated). nullable: true example: string IssuingCity: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: City where the document was issued (or `null` if the issuing city should not be updated). nullable: true example: string IdentityDocumentSupportNumber: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Identity document support number. Only required for Spanish identity cards in Spanish hotels. nullable: true example: '1001' additionalProperties: false x-schema-id: IdentityDocumentUpdateParameters IdentityDocumentWriteResult: title: IdentityDocumentWriteResult required: - IdentityDocuments type: object properties: IdentityDocuments: maxItems: 10 type: array items: $ref: '#/components/schemas/IdentityDocumentV20241025' description: Modified identity documents. additionalProperties: false x-schema-id: IdentityDocumentWriteResult IdentityDocumentDeleteParameters: title: IdentityDocumentDeleteParameters required: - AccessToken - Client - ClientToken - IdentityDocumentIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ChainId: type: string description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IdentityDocumentIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the identity documents to be deleted. additionalProperties: false x-schema-id: IdentityDocumentDeleteParameters IdentityDocumentsAddParameters: title: Identity document add parameters required: - AccessToken - Client - ClientToken - IdentityDocuments type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ChainId: type: string description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IdentityDocuments: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/IdentityDocumentsAddData' description: Identity documents to be added. additionalProperties: false x-schema-id: IdentityDocumentsAddParameters IdentityDocumentClearParameters: title: IdentityDocumentClearParameters required: - AccessToken - Client - ClientToken - CustomerIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ChainId: type: string description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerIds: maxItems: 10 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the `Customer` for whom documents will be deleted. additionalProperties: false x-schema-id: IdentityDocumentClearParameters IdentityDocumentFilterParameters: title: IdentityDocumentFilterParameters required: - AccessToken - Client - ClientToken - CustomerIds - Limitation type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string ChainIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `Chain`. If not specified, the operation returns data for all chains within scope of the Access Token. nullable: true IdentityDocumentIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `Identity document`. nullable: true CustomerIds: maxItems: 100 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `Customer`. Types: uniqueItems: true type: array items: $ref: '#/components/schemas/IdentityDocumentTypeEnum' description: Type of the identity document. nullable: true additionalProperties: false x-schema-id: IdentityDocumentFilterParameters IdentityDocumentV20241025: title: Identity document (ver 2024-10-25) required: - CustomerId - Id - Number - Type type: object properties: Id: type: string description: Unique identifier of the document. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CustomerId: type: string description: Identifier of the `Customer`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Type: title: Document type allOf: - $ref: '#/components/schemas/IdentityDocumentTypeEnum' description: 'Type of the document. IdentityCard Passport Visa DriversLicense' x-enumNames: - IdentityCard - Passport - Visa - DriversLicense x-enumDescriptions: - '' - '' - '' - '' example: string Number: minLength: 1 type: string description: Number of the document (e.g. passport number). The value is an empty string when the number is not collected in certain regions, such as The Netherlands. example: '1001' ExpirationDate: type: string description: Expiration date in ISO 8601 format. format: date nullable: true example: '2026-06-02' IssuanceDate: type: string description: Date of issuance in ISO 8601 format. format: date nullable: true example: '2026-06-02' IssuingCountryCode: type: string description: ISO 3166-1 code of the `Country`. nullable: true example: string IssuingCountrySubdivisionCode: type: string description: Identifier of the country subdivision where the document was issued (province, state or region). nullable: true example: string IssuingCity: type: string description: City where the document was issued. nullable: true example: string IdentityDocumentSupportNumber: type: string description: Identity document support number. Only required for Spanish identity cards in Spanish hotels. nullable: true example: '1001' additionalProperties: false x-schema-id: IdentityDocumentV20241025 IdentityDocumentsAddData: title: Identity document parameters required: - CustomerId - Number - Type type: object properties: CustomerId: type: string description: Identifier of the `Customer`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Type: title: Document type allOf: - $ref: '#/components/schemas/IdentityDocumentTypeEnum' description: 'Type of the document. IdentityCard Passport Visa DriversLicense' x-enumNames: - IdentityCard - Passport - Visa - DriversLicense x-enumDescriptions: - '' - '' - '' - '' example: string Number: minLength: 1 type: string description: Number of the document (e.g. passport number). If the number is not collected in certain regions, such as The Netherlands, use an empty string. In all other cases, a value should be supplied. example: '1001' ExpirationDate: type: string description: Expiration date in ISO 8601 format. format: date nullable: true example: '2026-06-02' IssuanceDate: type: string description: Date of issuance in ISO 8601 format. format: date nullable: true example: '2026-06-02' IssuingCountryCode: type: string description: ISO 3166-1 code of the `Country`). nullable: true example: string IssuingCountrySubdivisionCode: type: string description: Identifier of the country subdivision where the document was issued (province, state or region). nullable: true example: string IssuingCity: type: string description: City where the document was issued. nullable: true example: string IdentityDocumentSupportNumber: type: string description: Identity document support number. Only required for Spanish identity cards in Spanish hotels. nullable: true example: '1001' additionalProperties: false x-schema-id: IdentityDocumentsAddData MultipleIdentityDocumentUpdateParameters: title: Multiple identity document update parameters required: - AccessToken - Client - ClientToken - IdentityDocuments type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ChainId: type: string description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IdentityDocuments: maxItems: 10 minItems: 1 type: array items: $ref: '#/components/schemas/IdentityDocumentUpdateParameters' description: Identity documents to be updated. additionalProperties: false x-schema-id: MultipleIdentityDocumentUpdateParameters StringUpdateValue: title: String update value type: object properties: Value: type: string description: Value which is to be updated. nullable: true example: string additionalProperties: false x-schema-id: StringUpdateValue IdentityDocumentTypeUpdateValue: title: Identity document type update value type: object properties: Value: title: Document type allOf: - $ref: '#/components/schemas/IdentityDocumentTypeEnum' description: 'Type of the document (or `null` if the type should not be updated). IdentityCard Passport Visa DriversLicense' x-enumNames: - IdentityCard - Passport - Visa - DriversLicense x-enumDescriptions: - '' - '' - '' - '' example: string additionalProperties: false description: Has same structure as [String update value](https://mews-systems.gitbook.io/connector-api/operations/_objects#string-update-value). x-schema-id: IdentityDocumentTypeUpdateValue IdentityDocumentResult: title: IdentityDocumentResult required: - IdentityDocuments type: object properties: IdentityDocuments: maxItems: 1000 type: array items: $ref: '#/components/schemas/IdentityDocumentV20241025' description: The identity documents of customers. Cursor: type: string description: Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: IdentityDocumentResult securitySchemes: MewsClientToken: type: apiKey in: header name: ClientToken description: Mews authentication is performed by supplying ClientToken, AccessToken and Client as fields in the JSON request body (not as HTTP headers). This securityScheme is a tooling-compatible representation of the ClientToken credential. ClientToken is unique to your application and identifies the API client. MewsAccessToken: type: apiKey in: header name: AccessToken description: Tooling-compatible representation of the AccessToken credential, which is supplied in the JSON request body. AccessToken is unique to the connection with a property (enterprise) and identifies the property or properties whose data and services you can access. Portfolio Access Tokens enable multi-property access with a single token.