Sign in
latestOpenAPI 3.0.12026-08-105551287.6 KB

c481fa2414f9

Person identifications

Update legitimation data

Update the legitimation data of an identification

patch/v1/persons/{person_id}/identifications/{id}/legitimation_data

Path parameters

person_idstring required

The unique ID of the person resource created for a customer.

Example:dc1a6812a14f6cc338cd084208535bcdcper
idstring required

The unique ID of the identification resource created for a customer.

Example:6dc54352d6793a892e0702850d07b831cidt

Request body

legitimation_document_numberstring required

The document number of the legitimation

legitimation_typestring

Legitimation type

legitimation_issuerstring

Issuer of the legitimation

legitimation_countrystring

Country that issued legitimation

legitimation_issued_atstring date

The date at which the legitimation was issued at. Note Not required for Spanish ID cards.

legitimation_valid_untilstring date

The date until which the legitimation is valid

Example request

{
  "legitimation_document_number": "12345678910",
  "legitimation_type": "PASSPORT",
  "legitimation_issuer": "Stadt Heidelberg",
  "legitimation_country": "GERMANY",
  "legitimation_issued_at": "2010-01-01",
  "legitimation_valid_until": "2020-01-01"
}

Response

Successful result of the operation

legitimation_document_numberstring

The document number of the legitimation document.

legitimation_type'IDCARD' | 'PASSPORT'

The type of the legitimation document.

legitimation_issuerstring

Issuer of the legitimation document.

legitimation_countrystring

Country that issued the legitimation document.

legitimation_issued_atstring date

The date when the legitimation document was issued. Note Not required for Spanish ID cards.

legitimation_valid_untilstring date

The date when the legitimation document expires.

Example response

{
  "legitimation_document_number": "123456789",
  "legitimation_type": "PASSPORT",
  "legitimation_issuer": "Stadt Heidelberg",
  "legitimation_country": "GERMANY",
  "legitimation_issued_at": "2015-10-15",
  "legitimation_valid_until": "2025-10-14"
}