Get all identity documents
POST /api/connector/v1/identityDocuments/getAll
Returns all identity documents for the specified customers, with additional filtering options available. This operation supports Portfolio Access Tokens.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of Chain. If not specified, the operation returns data for all chains within scope of the Access Token.
Unique identifiers of Identity document.
Unique identifiers of Customer.
Type of the identity document.
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
Section titled “ Responses ”OK
object
The identity documents of customers.
object
Unique identifier of the document.
Identifier of the Customer.
Type of the document.
IdentityCard
Passport
Visa
DriversLicense
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.
Expiration date in ISO 8601 format.
Date of issuance in ISO 8601 format.
ISO 3166-1 code of the Country.
City where the document was issued.
Identity document support number. Only required for Spanish identity cards in Spanish hotels.
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.
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", "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", "IssuingCity": "Brno", "IdentityDocumentSupportNumber": "B-321" } ], "Cursor": "cbe8a32e-3eb7-4226-baf4-69455a0eeaf4"}Server has successfully fulfilled the request and there is no additional information to send back.
object
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).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
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.
object
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
object
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.
object
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.