Identity documents
Last updated
Was this helpful?
Last updated
Was this helpful?
Returns all identity documents for the specified customers, with additional filtering options available. This operation supports .
[PlatformAddress]/api/connector/v1/identityDocuments/getAll
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.
ChainIds
array of string
optional, max 1000 items
Unique identifiers of Chain
. If not specified, the operation returns data for all chains within scope of the Access Token.
IdentityDocumentIds
array of string
optional, max 100 items
Unique identifiers of Identity document
.
CustomerIds
array of string
required, max 100 items
Unique identifiers of Customer
.
Types
optional
Type of the identity document.
Limitation
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
IdentityDocuments
required, max 1000 items
The identity documents of customers.
Cursor
string
optional
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.
Id
string
required
Unique identifier of the document.
CustomerId
string
required
Identifier of the Customer
.
Type
required
Type of the document.
Number
string
required
Number of the document (e.g. passport number).
ExpirationDate
string
optional
Expiration date in ISO 8601 format.
IssuanceDate
string
optional
Date of issuance in ISO 8601 format.
IssuingCountryCode
string
optional
ISO 3166-1 code of the Country
.
IssuingCity
string
optional
City where the document was issued.
IdentityDocumentSupportNumber
string
optional
Identity document support number. Only required for Spanish identity cards in Spanish hotels.
[PlatformAddress]/api/connector/v1/identityDocuments/add
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
optional
IdentityDocuments
required, max 10 items
Identity documents to be added.
CustomerId
string
required
Identifier of the Customer
.
Type
required
Type of the document.
Number
string
required
Number of the document (e.g. passport number).
ExpirationDate
string
optional
Expiration date in ISO 8601 format.
IssuanceDate
string
optional
Date of issuance in ISO 8601 format.
IssuingCountryCode
string
optional
ISO 3166-1 code of the Country
).
IssuingCity
string
optional
City where the document was issued.
IdentityDocumentSupportNumber
string
optional
Identity document support number. Only required for Spanish identity cards in Spanish hotels.
IdentityDocuments
required, max 10 items
Modified identity documents.
[PlatformAddress]/api/connector/v1/identityDocuments/update
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
optional
IdentityDocuments
required, max 10 items
Identity documents to be updated.
Id
string
required
Unique identifier of the document.
Type
optional
Type of the document (or null
if the number should not be updated).
Number
optional
Number of the document (e.g. passport number or null
if the number should not be updated).
ExpirationDate
optional
Expiration date in ISO 8601 format (or null
if the expiration date should not be updated).
IssuanceDate
optional
Date of issuance in ISO 8601 format (or null
if the issuance date should not be updated).
IssuingCountryCode
optional
ISO 3166-1 code of the Country
(or null
if the issuing country code should not be updated).
IssuingCity
optional
City where the document was issued (or null
if the issuing city should not be updated).
IdentityDocumentSupportNumber
optional
Identity document support number. Only required for Spanish identity cards in Spanish hotels.
Value
required
Type of the document (or null
if the number should not be updated).
IdentityDocuments
required, max 10 items
Modified identity documents.
[PlatformAddress]/api/connector/v1/identityDocuments/delete
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
optional
IdentityDocumentIds
array of string
required, max 100 items
Unique identifiers of the identity documents to be deleted.
[PlatformAddress]/api/connector/v1/identityDocuments/clear
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
optional
CustomerIds
array of string
required, max 10 items
Unique identifiers of the Customer
for whom documents will be deleted.
array of
array of
Adds identity documents. This operation supports .
Unique identifier of the chain. Required when using , ignored otherwise.
array of
array of
Updates specified identity documents. This operation supports .
Unique identifier of the chain. Required when using , ignored otherwise.
array of
Has same structure as .
array of
Deletes specified identity documents. This operation supports .
Unique identifier of the chain. Required when using , ignored otherwise.
Deletes all identity documents for the specified customers. This operation supports .
Unique identifier of the chain. Required when using , ignored otherwise.