# 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

PersonalBusiness

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| first\_name | `string` | Yes | First name of the personal identity. |
| last\_name | `string` | Yes | Last name of the personal identity. |
| phone\_number | `string` | Yes | 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. |

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| company\_name | `string` | Yes | Company name of the business identity. |
| company\_reg\_number | `string` | No | Company registration number of the business identity. |
| vat\_id | `string` | No | Company VAT ID of the business identity. |
| first\_name | `string` | Yes | Company's representative first name of the business identity. |
| last\_name | `string` | Yes | Company's representative last name of the business identity. |
| phone\_number | `string` | Yes | 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. |

### Request Body Object Relationships

| Title | Type | Description |
| --- | --- | --- |
| country | [Country Object](../../coverage-resources/countries/country-object.html#country-object-v34) | Specifies the country for identity. Required for business identity updates in the Postman schema. |
| birth\_country | [Country Object](../../coverage-resources/countries/country-object.html#country-object-v34) | Specifies the birth country for identity. Send an empty string to remove the current `birth_country` value. |

Note

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

## Examples

Simple Resource PatchRemove birth\_country

[[DIDWW-API-EXAMPLE-START]]

http

```
PATCH /v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70 HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "id": "46e129f1-deaa-44db-8915-2646de4d4c70",
    "type": "identities",
    "attributes": {
      "birth_date": "2000-01-01",
      "phone_number": "35319015266",
      "last_name": "Smith",
      "contact_email": "support@didww.com",
      "vat_id": null,
      "id_number": "0000000000",
      "description": "string",
      "personal_tax_id": "string"
    },
    "relationships": {
      "birth_country": {
        "data": {
          "id": "c8647639-fc9c-47b2-acec-7c9e14465c25",
          "type": "countries"
        }
      }
    }
  }
}
```

curl

```
curl -i -X PATCH https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70 -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"birth_date": "2000-01-01", "contact_email": "support@didww.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

```
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c",
    "type": "identities",
    "attributes": {
      "first_name": "Jane",
      "last_name": "Smith",
      "phone_number": "35319015266",
      "id_number": "0000000000",
      "birth_date": "2000-01-01",
      "company_name": "string",
      "company_reg_number": null,
      "vat_id": null,
      "description": "string",
      "personal_tax_id": "string",
      "identity_type": "personal",
      "created_at": "2020-09-14T07:29:41.393Z",
      "contact_email": "support@didww.com",
      "external_reference_id": null
    },
    "relationships": {
      "country": {
        "links": {
          "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/country",
          "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/country"
        }
      },
      "birth_country": {
        "links": {
          "self": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/birth_country",
          "related": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/birth_country"
        }
      },
      "proofs": {
        "links": {
          "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/proofs",
          "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/proofs"
        }
      },
      "addresses": {
        "links": {
          "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/addresses",
          "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/addresses"
        }
      },
      "permanent_documents": {
        "links": {
          "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/permanent_documents",
          "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/permanent_documents"
        }
      }
    }
  },
  "meta": {
    "api_version": "2026-04-16"
  }
}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
PATCH /v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70 HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "id": "46e129f1-deaa-44db-8915-2646de4d4c70",
    "type": "identities",
    "relationships": {
      "birth_country": {
        "data": ""
      }
    }
  }
}
```

curl

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

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 404 | No | [Not Found](../../../specification/errors/index.html#api-not-found) |
| 401 | No | [Unauthorized](../../../configuration.html#api-key) |

On this page