# Update Identity

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

## Request

HTTP Method: `PATCH`

URI Path: `/v3/identities/{id}`

### URI Query Parameters

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| id | `string` | Yes | Unique ID identifier of the Identity. |

## Attributes

All attributes are optional: send only the ones to change.

PersonalBusiness

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| first\_name | `string` | No | First name of the personal identity. |
| last\_name | `string` | No | Last name of the personal identity. |
| phone\_number | `string` | No | Phone number of the personal identity. Only digits allowed. |
| personal\_tax\_id | `string` | No | Personal tax ID of the personal identity. |
| birth\_date | `string` | No | Birth date of the personal identity in ISO 8601 format. |
| id\_number | `string` | No | ID number of the personal identity. |
| description | `string` | No | Description of the personal identity. |
| external\_reference\_id | `string` | No | Identifier for identity in external system. |
| contact\_email | `string` | No | Contact email address of identity. Must be a valid email address. |

`company_website` is not accepted for a personal identity: sending a value returns `422 Unprocessable Entity`.

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| company\_name | `string` | No | Company name of the business identity. |
| company\_website | `string` | No | Company website of the business identity. Send `null` to remove it. Once the identity is in use, for example linked to DIDs or to a verification, a stored `company_website` cannot be changed or removed: the request returns `422 Unprocessable Entity`. |
| company\_reg\_number | `string` | No | Company registration number of the business identity. |
| vat\_id | `string` | No | Company VAT ID of the business identity. Listed as `tax_id` in the mandatory fields of the address and emergency requirements. |
| first\_name | `string` | No | Company's representative first name of the business identity. |
| last\_name | `string` | No | Company's representative last name of the business identity. |
| phone\_number | `string` | No | Company's representative phone number of the business identity. Only digits allowed. |
| personal\_tax\_id | `string` | No | Company's representative Tax ID of the business identity. |
| birth\_date | `string` | No | Company's representative Birth date of the business identity in ISO 8601 format. |
| id\_number | `string` | No | Company's representative ID number of the business identity. |
| description | `string` | No | Description of the business identity. |
| external\_reference\_id | `string` | No | Identifier for identity in external system. |
| contact\_email | `string` | No | Contact email address of identity. Must be a valid email address. |

Note

Once the identity is in use, for example linked to DIDs or to a verification, `first_name`,
`last_name` and `company_name` cannot be changed. The same applies to `company_website`,
`company_reg_number`, `id_number`, `personal_tax_id`, `birth_date` and `country`
once a value is stored for them. Such a request returns `422 Unprocessable Entity`.
Once stored, `id_number`, `company_reg_number`, `personal_tax_id` and `birth_date`
cannot be removed: sending `null` returns `422 Unprocessable Entity`.

### Request Body Object Relationships

| Title | Type | Description |
| --- | --- | --- |
| country | [Country Object](../../coverage-resources/countries/country-object.html#country-object-v35) | Specifies the country for identity. Required when `vat_id` is set. Once set, it cannot be removed. Once the identity is in use, for example linked to DIDs or to a verification, it cannot be changed either: the request returns `422 Unprocessable Entity`. |
| birth\_country | [Country Object](../../coverage-resources/countries/country-object.html#country-object-v35) | Specifies the birth country for identity. Once set, it can be changed but not removed: sending `null` returns `422 Unprocessable Entity`. |

Note

Assigning `country` does not automatically assign `birth_country`. Set `birth_country` explicitly when needed.

## Examples

Simple Resource PatchRemoving birth\_country is rejected

[[DIDWW-API-EXAMPLE-START]]

http

```
 1PATCH /v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70 HTTP/1.1
 2Host: api.didww.com
 3Content-Type: application/vnd.api+json
 4Accept: application/vnd.api+json
 5Authorization: Bearer [access token]
 6
 7{
 8  "data": {
 9    "id": "46e129f1-deaa-44db-8915-2646de4d4c70",
10    "type": "identities",
11    "attributes": {
12      "birth_date": "2000-01-01",
13      "phone_number": "35319015266",
14      "last_name": "Smith",
15      "contact_email": "jane@example.com",
16      "vat_id": null,
17      "id_number": "0000000000",
18      "description": "string",
19      "personal_tax_id": "string"
20    },
21    "relationships": {
22      "birth_country": {
23        "data": {
24          "id": "c8647639-fc9c-47b2-acec-7c9e14465c25",
25          "type": "countries"
26        }
27      }
28    }
29  }
30}
```

curl

```
1curl -i -X PATCH https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"attributes": {"birth_date": "2000-01-01", "contact_email": "jane@example.com", "description": "string", "id_number": "0000000000", "last_name": "Smith", "personal_tax_id": "string", "phone_number": "35319015266", "vat_id": null}, "id": "46e129f1-deaa-44db-8915-2646de4d4c70", "relationships": {"birth_country": {"data": {"id": "c8647639-fc9c-47b2-acec-7c9e14465c25", "type": "countries"}}}, "type": "identities"}}'
```

response

```
 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "46e129f1-deaa-44db-8915-2646de4d4c70",
 7    "type": "identities",
 8    "attributes": {
 9      "first_name": "Jane",
10      "last_name": "Smith",
11      "phone_number": "35319015266",
12      "id_number": "0000000000",
13      "birth_date": "2000-01-01",
14      "company_name": null,
15      "company_website": null,
16      "company_reg_number": null,
17      "vat_id": null,
18      "description": "string",
19      "personal_tax_id": "string",
20      "identity_type": "personal",
21      "created_at": "2020-09-14T07:29:41.393Z",
22      "external_reference_id": null,
23      "verified": false,
24      "contact_email": "jane@example.com"
25    },
26    "relationships": {
27      "country": {
28        "links": {
29          "self": "https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/country",
30          "related": "https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70/country"
31        }
32      },
33      "birth_country": {
34        "links": {
35          "self": "https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/birth_country",
36          "related": "https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70/birth_country"
37        }
38      },
39      "proofs": {
40        "links": {
41          "self": "https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/proofs",
42          "related": "https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70/proofs"
43        }
44      },
45      "addresses": {
46        "links": {
47          "self": "https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/addresses",
48          "related": "https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70/addresses"
49        }
50      },
51      "permanent_documents": {
52        "links": {
53          "self": "https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70/relationships/permanent_documents",
54          "related": "https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70/permanent_documents"
55        }
56      }
57    }
58  },
59  "meta": {
60    "api_version": "2026-11-19"
61  }
62}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
 1PATCH /v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70 HTTP/1.1
 2Host: api.didww.com
 3Content-Type: application/vnd.api+json
 4Accept: application/vnd.api+json
 5Authorization: Bearer [access token]
 6
 7{
 8  "data": {
 9    "id": "46e129f1-deaa-44db-8915-2646de4d4c70",
10    "type": "identities",
11    "relationships": {
12      "birth_country": {
13        "data": null
14      }
15    }
16  }
17}
```

curl

```
1curl -i -X PATCH https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70 -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]" --data-raw '{"data": {"id": "46e129f1-deaa-44db-8915-2646de4d4c70", "relationships": {"birth_country": {"data": null}}, "type": "identities"}}'
```

response

```
 1HTTP/1.1 422 Unprocessable Entity
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "errors": [
 6    {
 7      "title": "can't be blank",
 8      "detail": "birth_country - can't be blank",
 9      "code": "100",
10      "source": {
11        "pointer": "/data/relationships/birth_country"
12      },
13      "status": "422"
14    }
15  ]
16}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 404 | No | [Not Found](../../../specification/errors/index.html#api-not-found) |
| 400 | No | [Bad Request](../../../specification/errors/index.html#api-bad-request) |
| 401 | No | [Unauthorized](../../authentication.html#authentication-v35) |
| 403 | No | The access token carries the `read` scope, which does not cover this method (title `Insufficient scope`). The response carries `WWW-Authenticate: Bearer error="insufficient_scope"`. See [Scopes](../../authentication.html#authentication-scopes-v35). |
| 422 | No | [Validation error](../../../specification/errors/index.html#api-validation-error-object) |
| 429 | No | The request budget of the account for the current window is spent (`too_many_requests`). `Retry-After` gives the number of seconds to wait. |
