# Create address

Create a new address for the specified account.

This endpoint generates an [Address created](https://developers.pismo.io/events/docs/audit-address-creation-1) event.


# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Core platform - Accounts",
    "version": "1.0.0",
    "description": "API used to manage accounts domain",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io",
      "description": "API server for testing"
    }
  ],
  "tags": [
    {
      "name": "Addresses",
      "description": "Endpoints to manage addresses"
    }
  ],
  "components": {
    "parameters": {
      "AccountIdPath": {
        "name": "accountId",
        "in": "path",
        "description": "Account ID",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64",
          "minimum": 1,
          "example": 123
        }
      },
      "AddressActiveQuery": {
        "name": "active",
        "in": "query",
        "description": "Is address active?",
        "schema": {
          "type": "boolean",
          "example": true,
          "enum": [
            false,
            true
          ]
        }
      }
    },
    "schemas": {
      "Address": {
        "type": "string",
        "description": "Street, avenue, road, and so on, name.",
        "maxLength": 300,
        "example": "Mulholland Drive"
      },
      "AddressActive": {
        "type": "boolean",
        "description": "Is address active (`true`) or not (`false`). Default is `true`.",
        "example": true
      },
      "AddressItemRequest": {
        "type": "object",
        "description": "An address request",
        "required": [
          "type",
          "address",
          "number",
          "zip_code",
          "city",
          "state",
          "country",
          "neighborhood"
        ],
        "properties": {
          "type": {
            "$ref": "#/components/schemas/AddressType"
          },
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "number": {
            "$ref": "#/components/schemas/AddressNumberInput"
          },
          "zip_code": {
            "$ref": "#/components/schemas/ZipCode"
          },
          "city": {
            "$ref": "#/components/schemas/City"
          },
          "state": {
            "$ref": "#/components/schemas/State"
          },
          "country": {
            "$ref": "#/components/schemas/Country"
          },
          "neighborhood": {
            "$ref": "#/components/schemas/Neighborhood"
          },
          "active": {
            "$ref": "#/components/schemas/AddressActive"
          },
          "complementary_address": {
            "$ref": "#/components/schemas/ComplementaryAddress"
          },
          "custom_fields": {
            "$ref": "#/components/schemas/CustomFields"
          },
          "mailing_address": {
            "$ref": "#/components/schemas/MailingAddress"
          }
        }
      },
      "AddressNumberInput": {
        "type": "string",
        "maxLength": 9,
        "description": "Address number as string or integer. \n\nIf you enter numeric characters, they are saved in the `number` address object field.\n\nIf you enter any non-numeric characters, all characters are saved in the `extended_number` address object field. \n\nFor example, if you enter \"12 A\", it gets saved as follows:\n  *  `number` = 12\n  *  `extended_number` = \"12 A\"\n"
      },
      "AddressType": {
        "type": "string",
        "description": "Address type",
        "enum": [
          "RESIDENTIAL",
          "COMMERCIAL",
          "OTHER"
        ],
        "example": "RESIDENTIAL"
      },
      "BadRequestError": {
        "type": "object",
        "title": "BadRequestError",
        "description": "Bad request error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Message describing the error"
          },
          "field": {
            "type": "string",
            "description": "Text identifying the ill-formatted field"
          }
        },
        "required": [
          "message",
          "field"
        ]
      },
      "City": {
        "type": "string",
        "description": "Address city",
        "maxLength": 100,
        "example": "San Diego"
      },
      "ComplementaryAddress": {
        "type": "string",
        "description": "Any additional information such as suite, apt., and so on.",
        "maxLength": 100,
        "example": "Apt 1408"
      },
      "Country": {
        "type": "string",
        "description": "Address country",
        "maxLength": 30,
        "example": "Brazil"
      },
      "CustomFields": {
        "type": "object",
        "description": "Key/value field for custom information. (Limited to 1014 bytes.)",
        "example": {
          "field_01": "value01",
          "field_02": "value02"
        }
      },
      "MailingAddress": {
        "type": "boolean",
        "description": "Is this address the mailing address?\n\nOnly one address can have this field set to `true`.\n",
        "example": true
      },
      "Neighborhood": {
        "type": "string",
        "description": "Address neighborhood. Some countries use neighborhood in addresses.",
        "maxLength": 100,
        "example": "Shady Pines"
      },
      "SimpleError": {
        "title": "SimpleError",
        "type": "object",
        "required": [
          "message"
        ],
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "State": {
        "type": "string",
        "description": "Address state",
        "maxLength": 30,
        "example": "California"
      },
      "ZipCode": {
        "type": "string",
        "maxLength": 16,
        "description": "Zip/postal code",
        "example": "12345-678"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  },
  "paths": {
    "/accounts/v1/accounts/{accountId}/addresses": {
      "post": {
        "operationId": "post-accounts-v1-accounts-accountId-addresses",
        "summary": "Create address",
        "description": "Create a new address for the specified account.\n\nThis endpoint generates an [Address created](https://developers.pismo.io/events/docs/audit-address-creation-1) event.\n",
        "tags": [
          "Addresses"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/AccountIdPath"
          },
          {
            "$ref": "#/components/parameters/AddressActiveQuery"
          }
        ],
        "requestBody": {
          "description": "Address entity",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AddressItemRequest"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "The address was successfully created",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "id": {
                      "type": "integer",
                      "format": "int64",
                      "example": 1472162
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BadRequestError"
                },
                "examples": {
                  "Bad payload": {
                    "value": {
                      "message": "Field should be boolean",
                      "field": "mailing_address"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SimpleError"
                },
                "examples": {
                  "Internal server error": {
                    "value": {
                      "message": "Not possible to create the address"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```