Update Identity#
Update the settings of a single Identity owned by your account.
Request#
HTTP Method: PATCH
URI Path: /v3/identities/
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID identifier of the Identity. |
Attributes#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
first_name |
|
No |
First name of the personal identity. |
last_name |
|
No |
Last name of the personal identity. |
phone_number |
|
No |
Phone number of the personal identity. |
personal_tax_id |
|
No |
Personal tax ID of the personal identity. |
birth_date |
|
No |
Birth date of the personal identity in ISO 8601 format. |
id_number |
|
No |
ID number of the personal identity. |
description |
|
No |
Description of the personal identity. |
external_reference_id |
|
No |
Identifier for identity in external system. |
contact_email |
|
No |
Contact email address of identity. |
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
company_name |
|
No |
Company name of the business identity. |
company_reg_number |
|
No |
Company registration number of the business identity. |
vat_id |
|
No |
Company VAT ID of the business identity. |
first_name |
|
No |
Company’s representative First name of the business identity. |
last_name |
|
No |
Company’s representative Last name of the business identity. |
phone_number |
|
No |
Company’s representative Phone number of the business identity. |
personal_tax_id |
|
No |
Company’s representative Tax ID of the business identity. |
birth_date |
|
No |
Company’s representative Birth date of the business identity in ISO 8601 format. |
id_number |
|
No |
Company’s representative ID number of the business identity. |
description |
|
No |
Company’s representative description of the business identity. |
external_reference_id |
|
No |
Identifier for identity in external system. |
contact_email |
|
No |
Contact email address of identity. |
Examples#
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
5Api-Key: [API 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": "support@didww.com",
16 "vat_id": null,
17 "id_number": "0000000000",
18 "description": "string",
19 "personal_tax_id": "string"
20 }
21 }
22}
curl
1curl -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", "type": "identities"}}'
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c",
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": "string",
15 "company_reg_number": null,
16 "vat_id": null,
17 "description": "string",
18 "personal_tax_id": "string",
19 "identity_type": "Personal",
20 "created_at": "2020-09-14T07:29:41.393Z",
21 "contact_email": "support@didww.com"
22 },
23 "relationships": {
24 "country": {
25 "links": {
26 "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/country",
27 "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/country"
28 }
29 },
30 "proofs": {
31 "links": {
32 "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/proofs",
33 "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/proofs"
34 }
35 },
36 "addresses": {
37 "links": {
38 "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/addresses",
39 "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/addresses"
40 }
41 },
42 "permanent_documents": {
43 "links": {
44 "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/permanent_documents",
45 "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/permanent_documents"
46 }
47 }
48 }
49 },
50 "meta": {
51 "api_version": "2022-05-10"
52 }
53}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |