Update identity documents
POST /api/connector/v1/identityDocuments/update
Updates specified identity documents. 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.
Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.
Identity documents to be updated.
object
Unique identifier of the document.
Type of the document (or null if the number should not be updated).
object
Type of the document (or null if the number should not be updated).
IdentityCard
Passport
Visa
DriversLicense
Number of the document (e.g. passport number or null if the number should not be updated).
object
Value which is to be updated.
Expiration date in ISO 8601 format (or null if the expiration date should not be updated).
object
Value which is to be updated.
Date of issuance in ISO 8601 format (or null if the issuance date should not be updated).
object
Value which is to be updated.
ISO 3166-1 code of the Country (or null if the issuing country code should not be updated).
object
Value which is to be updated.
City where the document was issued (or null if the issuing city should not be updated).
object
Value which is to be updated.
Identity document support number. Only required for Spanish identity cards in Spanish hotels.
object
Value which is to be updated.
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
Section titled “ Responses ”OK
object
Modified identity documents.
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.
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" } ]}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.