Create Address

POST https://{{host}}/v3/addresses

Creates an Address that can be assigned to an Identity.

Request Body Scheme

{

data (object, required) {

type (string, required): addresses

attributes (object, required) {

city_name (string, required)
City name of the address.

postal_code (string, required)
Postal code of the address.

address (string, required)
Full address.

description (string, optional)
The description of the address.

}

relationships (object, required) {

identity (object, required): to-one
Specifies the Identity for the address.

country (object , required): to-one
Specifies the Country for the address.

}

}

}

Request Body Example

Simple Resource Patch

{
  "data": {
    "type": "addresses",
    "attributes": {
      "city_name": "string",
      "postal_code": "string",
      "address": "string",
      "description": "string"
    },
    "relationships": {
      "identity": {
        "data": {
          "id": "identity_id_string",
          "type": "identities"
        }
      },
      "country": {
        "data": {
          "id": "country_id_string",
          "type": "countries"
        }
      }
    }
  }
}

HEADERS

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

RESPONSES

status: Created

{&quot;data&quot;:{&quot;id&quot;:&quot;49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0&quot;,&quot;type&quot;:&quot;addresses&quot;,&quot;attributes&quot;:{&quot;city_name&quot;:&quot;string&quot;,&quot;postal_code&quot;:&quot;string&quot;,&quot;address&quot;:&quot;string&quot;,&quot;description&quot;:&quot;string&quot;,&quot;created_at&quot;:&quot;2020-09-16T10:23:07.846Z&quot;,&quot;verified&quot;:false},&quot;relationships&quot;:{&quot;identity&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/identity&quot;,&quot;related&quot;:&quot;https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/identity&quot;}},&quot;country&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/country&quot;,&quot;related&quot;:&quot;https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/country&quot;}},&quot;proofs&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/proofs&quot;,&quot;related&quot;:&quot;https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/proofs&quot;}},&quot;area&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/area&quot;,&quot;related&quot;:&quot;https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/area&quot;}},&quot;city&quot;:{&quot;links&quot;:{&quot;self&quot;:&quot;https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/relationships/city&quot;,&quot;related&quot;:&quot;https://api.didww.com/v3/addresses/49f09b7f-c5bf-4c90-bac1-a8b335d2c3f0/city&quot;}}}},&quot;meta&quot;:{&quot;api_version&quot;:&quot;2022-05-10&quot;}}