Create Addresses#
Creates an Address that can be assigned to an Identity.
Request#
HTTP Method: POST
URI Path: /v3/addresses
Request Body Object Attributes#
Name |
Type |
Required |
Description |
|---|---|---|---|
city_name |
|
Yes |
City name of the address. |
postal_code |
|
Yes |
Postal code of the address. |
address |
|
Yes |
Full address. |
description |
|
No |
The description of the address. |
external_reference_id |
|
No |
Optional identifier for the address in the customer’s external system. Maximum length is 100 characters. |
Request Body Object Relationships#
Title |
Type |
Description |
|---|---|---|
countries |
Specifies the country for the address. |
|
identities |
Specifies the identity for the address. |
Examples#
http
1POST /v3/addresses 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 "type": "addresses",
10 "attributes": {
11 "city_name": "string",
12 "postal_code": "string",
13 "address": "string",
14 "description": "string"
15 },
16 "relationships": {
17 "identity": {
18 "data": {
19 "id": "6c832a1d-b19d-471b-b416-9b5bf2b6ef9d",
20 "type": "identities"
21 }
22 },
23 "country": {
24 "data": {
25 "id": "38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f",
26 "type": "countries"
27 }
28 }
29 }
30 }
31}
curl
1curl -i -X POST https://api.didww.com/v3/addresses -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"address": "string", "city_name": "string", "description": "string", "postal_code": "string"}, "relationships": {"country": {"data": {"id": "38003e8b-cccc-41d4-b1a6-d1e6fddf2c0f", "type": "countries"}}, "identity": {"data": {"id": "6c832a1d-b19d-471b-b416-9b5bf2b6ef9d", "type": "identities"}}}, "type": "addresses"}}'
response
1HTTP/1.1 201 Created
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0",
7 "type": "addresses",
8 "attributes": {
9 "city_name": "string",
10 "postal_code": "string",
11 "address": "string",
12 "description": "string",
13 "created_at": "2020-09-16T10:23:07.846Z",
14 "verified": false,
15 "external_reference_id": null
16 },
17 "relationships": {
18 "identity": {
19 "links": {
20 "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/identity",
21 "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/identity"
22 }
23 },
24 "country": {
25 "links": {
26 "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/country",
27 "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/country"
28 }
29 },
30 "proofs": {
31 "links": {
32 "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/proofs",
33 "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/proofs"
34 }
35 },
36 "area": {
37 "links": {
38 "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/area",
39 "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/area"
40 }
41 },
42 "city": {
43 "links": {
44 "self": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/city",
45 "related": "https://sandbox-api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/city"
46 }
47 }
48 }
49 },
50 "meta": {
51 "api_version": "2026-04-16"
52 }
53}
http
1POST /v3/addresses 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 "type": "addresses",
10 "attributes": {
11 "city_name": "Vilnius",
12 "postal_code": "LT80001",
13 "address": "Street 1",
14 "description": "yellow house"
15 },
16 "relationships": {
17 "identity": {
18 "data": {
19 "id": "6c832a1d-b19d-471b-b416-9b5bf2b6ef9d",
20 "type": "identities"
21 }
22 },
23 "country": {
24 "data": {
25 "id": "country_id_string",
26 "type": "countries"
27 }
28 }
29 }
30 }
31}
curl
1curl -i -X POST https://api.didww.com/v3/addresses -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"address": "Street 1", "city_name": "Vilnius", "description": "yellow house", "postal_code": "LT80001"}, "relationships": {"country": {"data": {"id": "country_id_string", "type": "countries"}}, "identity": {"data": {"id": "6c832a1d-b19d-471b-b416-9b5bf2b6ef9d", "type": "identities"}}}, "type": "addresses"}}'
response
1HTTP/1.1 422 Unprocessable Entity
2Content-Type: application/vnd.api+json
3
4{"errors": [{
5 "title": "is invalid",
6 "detail": "country - is invalid",
7 "code": "100",
8 "source": {"pointer": "/data/relationships/country"},
9 "status": "422"
10}]}
Other Responses#
Code |
Success |
Description |
|---|---|---|
422 |
No |
|
401 |
No |