Update Business Identity

PATCH https://{{host}}/v3/identities/:id

Update the settings of a single Identity owned by your account.

Request Body Scheme

{

data (object, required) {

id (string, required)
Unique ID identifier of Identity.

type (string, required): identities

attributes (object, required) {

company_name (string, required)
Company name of the business identity.

companyregnumber (string, optional)
Company registration number of the business identity.

vat_id (string, optional)
Company VAT ID of the business identity.

first_name (string, required)
Company’s representative First name of the business identity.

last_name (string, required)
Company’s representative Last name of the business identity.

phone_number (string, required)
Company’s representative Phone number of the business identity.

personaltaxid (string, optional)
Company’s representative Tax ID of the business identity.

birth_date (DateTime[string], optional)
Company’s representative Birth date of the business identity.

id_number (string, optional)
Company’s representative ID number of the business identity.

description (string, optional)
Description of the business identity.

externalreferenceid (string, optional)
Identifier for identity in external system

}

relationships (object, optional) {

country (object, required): to-one
Linkage for included Country Object
Specifies the country for identity.

}

}

}

Request Body Example

{
    "data": {
        "type": "identities",
        "attributes": {
            "first_name": "string",
            "last_name": "string",
            "phone_number": "string",
            "id_number": "string",
            "birth_date": "string",
            "company_name": "string",
            "company_reg_number": "string",
            "vat_id": "string",
            "description": "string",
            "personal_tax_id": "string",
        },
        "relationships": {
            "country": {
                "data": {
                    "id": "6d0effab-3fe3-4e07-acc6-1d3ddc717ebc",
                    "type": "countries"
                }
            }
        }
    }
}

Request Params

Key	Datatype	Description
`include`	null	Comma-separated values of include parameter.
The response will include a top-level object `relationships` with associated data under the appropriate resource key.
Details in Inclusion of Related Resources Article.

Allowed values:

country - Country Object

proofs - Proof Object

proofs.proof_type - Proof Type Object

addresses - Address Object

addresses.country - Country Object

permanent_documents - Permanent Document Object

permanent_documents.template - Supporting Document Template Object |

HEADERS

Key	Datatype	Required	Description
`Accept`	string
`Content-Type`	string
`Api-Key`	string

RESPONSES

status: OK

{&quot;data&quot;:{&quot;id&quot;:&quot;fb7f3f67-014c-496b-b918-f874f2689a40&quot;,&quot;type&quot;:&quot;identities&quot;,&quot;attributes&quot;:{&quot;first_name&quot;:&quot;string&quot;,&quot;last_name&quot;:&quot;string&quot;,&quot;phone_number&quot;:&quot;string&quot;,&quot;id_number&quot;:&quot;string&quot;,&quot;birth_date&quot;:null,&quot;company_name&quot;:&quot;string&quot;,&quot;company_reg_number&quot;:null,&quot;vat_id&quot;:null,&quot;description&quot;:&quot;string&quot;,&quot;personal_tax_id&quot;:&quot;string&quot;,&quot;identity_type&quot;:&quot;Business&quot;,&quot;created_at&quot;:&quot;2021-03-22T12:08:29.987Z&quot;,&quot;external_reference_id&quot;:null,&quot;verified&quot;:false},&quot;relationships&quot;:{&quot;country&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/relationships/country&quot;,&quot;related&quot;:&quot;https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/country&quot;}},&quot;proofs&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/relationships/proofs&quot;,&quot;related&quot;:&quot;https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/proofs&quot;}},&quot;addresses&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/relationships/addresses&quot;,&quot;related&quot;:&quot;https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/addresses&quot;}},&quot;permanent_documents&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/relationships/permanent_documents&quot;,&quot;related&quot;:&quot;https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/permanent_documents&quot;}}}},&quot;meta&quot;:{&quot;api_version&quot;:&quot;2021-12-15&quot;}}