Identities are the different profiles or trade names under which you can send documents from your administration.
Retrieve the default identity
Returns the default identity of this administration.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Retrieve the default identity › Responses
A list of identities
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
company_namecitycountryzipcodeaddress1address2emailphonebank_account_namebank_account_numberbank_account_bicupdated_atcreated_atchamber_of_commercetax_numberUpdates the default identity
Updates the default identity.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Updates the default identity › Responses
A list of identities
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
company_namecitycountryzipcodeaddress1address2emailphonebank_account_namebank_account_numberbank_account_bicupdated_atcreated_atchamber_of_commercetax_numberRetrieve identity by given id
Returns the identity with the given id.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Retrieve identity by given id › Responses
A identity
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
company_namecitycountryzipcodeaddress1address2emailphonebank_account_namebank_account_numberbank_account_bicupdated_atcreated_atchamber_of_commercetax_numberDeletes an identity
Deletes an identity. Always returns a 204 status code even if the identity could not be deleted.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Deletes an identity › Responses
Identity deleted
Updates an identity
Updates an identity.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Updates an identity › Responses
Identity updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
company_namecitycountryzipcodeaddress1address2emailphonebank_account_namebank_account_numberbank_account_bicupdated_atcreated_atchamber_of_commercetax_numberRetrieve identities
An administration can have multiple identities, for example to cover multiple tradenames or offices. This does not include the default identity.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Retrieve identities › Responses
A list of identities
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
company_namecitycountryzipcodeaddress1address2emailphonebank_account_namebank_account_numberbank_account_bicupdated_atcreated_atchamber_of_commercetax_numberCreates an identity
Most fields for an identity are required. You can provide zero or more custom fields, for each provided
custom field value the id and value are required.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Creates an identity › Responses
Identity created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
company_namecitycountryzipcodeaddress1address2emailphonebank_account_namebank_account_numberbank_account_bicupdated_atcreated_atchamber_of_commercetax_number