---
title: "Add identity documents"
method: POST
path: "/api/connector/v1/identityDocuments/add"
tags: ["Identity documents"]
---

# Add identity documents

`POST /api/connector/v1/identityDocuments/add`

Adds identity documents. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).

## Request body

- IdentityDocumentsAddParameters
  - `ClientToken` string, required — Token identifying the client application.
  - `AccessToken` string, required — Access token of the client application.
  - `Client` string, required — Name and version of the client application.
  - `ChainId` string, uuid, nullable — Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
  - `IdentityDocuments` IdentityDocumentsAddData[], required — Identity documents to be added.
    - `CustomerId` string, uuid, required — Identifier of the `Customer`.
    - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense', required — IdentityCard Passport Visa DriversLicense
    - `Number` string, required — 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.
    - `ExpirationDate` string, date, nullable — Expiration date in ISO 8601 format.
    - `IssuanceDate` string, date, nullable — Date of issuance in ISO 8601 format.
    - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`).
    - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region).
    - `IssuingCity` string, nullable — City where the document was issued.
    - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels.
    - `IsVerified` boolean, nullable — Whether the document has been verified. Defaults to `false` when not specified.

## Response `200`

OK

- IdentityDocumentWriteResult
  - `IdentityDocuments` IdentityDocumentV20241025[], required — Modified identity documents.
    - `Id` string, uuid, required — Unique identifier of the document.
    - `CustomerId` string, uuid, required — Identifier of the `Customer`.
    - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense', required — IdentityCard Passport Visa DriversLicense
    - `Number` string, required — 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.
    - `ExpirationDate` string, date, nullable — Expiration date in ISO 8601 format.
    - `IssuanceDate` string, date, nullable — Date of issuance in ISO 8601 format.
    - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`.
    - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region).
    - `IssuingCity` string, nullable — City where the document was issued.
    - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels.
    - `IsVerified` boolean, required — Whether the document has been verified.

## Other responses

- `204` — Server has successfully fulfilled the request and there is no additional information to send back.
- `400` — 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).
- `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
- `403` — 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.
- `408` — 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)
- `429` — 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).
- `500` — 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).

---

[API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/versions/81933a8ff730/schema)