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
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A list of identities
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
company_name
string | nullcity
string | nullcountry
string | nullzipcode
string | nulladdress1
string | nulladdress2
string | nullemail
string | nullphone
string | nullbank_account_name
string | nullbank_account_number
string | nullbank_account_bic
string | nullcustom_fields
object[]updated_at
string · date-timecreated_at
string · date-timechamber_of_commerce
string | nulltax_number
string | null
Updates the default identity
Updates the default identity.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A list of identities
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
company_name
string | nullcity
string | nullcountry
string | nullzipcode
string | nulladdress1
string | nulladdress2
string | nullemail
string | nullphone
string | nullbank_account_name
string | nullbank_account_number
string | nullbank_account_bic
string | nullcustom_fields
object[]updated_at
string · date-timecreated_at
string · date-timechamber_of_commerce
string | nulltax_number
string | null
Retrieve identity by given id
Returns the identity with the given id.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A identity
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
company_name
string | nullcity
string | nullcountry
string | nullzipcode
string | nulladdress1
string | nulladdress2
string | nullemail
string | nullphone
string | nullbank_account_name
string | nullbank_account_number
string | nullbank_account_bic
string | nullcustom_fields
object[]updated_at
string · date-timecreated_at
string · date-timechamber_of_commerce
string | nulltax_number
string | null
Deletes an identity
Deletes an identity. Always returns a 204 status code even if the identity could not be deleted.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Identity deleted
Updates an identity
Updates an identity.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Identity updated
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
company_name
string | nullcity
string | nullcountry
string | nullzipcode
string | nulladdress1
string | nulladdress2
string | nullemail
string | nullphone
string | nullbank_account_name
string | nullbank_account_number
string | nullbank_account_bic
string | nullcustom_fields
object[]updated_at
string · date-timecreated_at
string · date-timechamber_of_commerce
string | nulltax_number
string | null
Retrieve 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
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A list of identities
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
company_name
string | nullcity
string | nullcountry
string | nullzipcode
string | nulladdress1
string | nulladdress2
string | nullemail
string | nullphone
string | nullbank_account_name
string | nullbank_account_number
string | nullbank_account_bic
string | nullcustom_fields
object[]updated_at
string · date-timecreated_at
string · date-timechamber_of_commerce
string | nulltax_number
string | null
Creates 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
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Identity created
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
company_name
string | nullcity
string | nullcountry
string | nullzipcode
string | nulladdress1
string | nulladdress2
string | nullemail
string | nullphone
string | nullbank_account_name
string | nullbank_account_number
string | nullbank_account_bic
string | nullcustom_fields
object[]updated_at
string · date-timecreated_at
string · date-timechamber_of_commerce
string | nulltax_number
string | null