➕Create New Address

In order to validate a Customer's Address Document, you will first need to create an Address for a Customer before performing the Address Document validation.

Please note that we will perform the Validation on the Address Document against the customer details provided in the POST Create New Customer endpoint.

Create New Address

POST {{baseUrl}}/addresses

In order to validate an Address a unique Address identifier needs to be created. The Address identifier will contain details of the Customers place of residence.

Request Body

Name	Type	Description
customerId*	String	The UUID for a specific customer that gets generated and returned in the POST Create New Customer response. It ensures that the Bank Account is created and can be looked up in future for that specific customer.
address_line_1	String	This is the first line of the Customer's address. This is what the customer would enter for the first line of their address if they were filling out a form. It would usually be their street number and name (e.g. 12 Plain Street). If their address is in a complex or estate for example, it may be the unit number (e.g. Unit 53).
address_line_2	String	This is the second line of the Customer's address. This is what the customer would enter for the second line of their address if they were filling out a form. It is more common to have a second line in the address if it is in a complex or estate (e.g. Roeland Square).
suburb	String	This is the suburb where the address is located.
city	String	This is the city where the address is located.
province	String	This is the province where the address is located
postal_code	String	This is the 4-digit postal code.

201: Created Address Created

{
    "data": {
        "id": "{{addressId}}",
        "address_line_1": "10 Highlands Avenue",
        "address_line_2": "Anmar Mansions",
        "suburb": "Vredehoek",
        "city": "Cape Town",
        "province": "Western Cape",
        "postal_code": "8001"
    }
}
```

422: Unprocessable Entity Missing CustomerId

422: Unprocessable Entity Invalid CustomerId

409: Conflict Duplicate Address

Example Request Body

```json
{
    "customer_id": "{{customerId}}",
    "address_line_1": "22 Eton Park",
    "address_line_2": "6 Eton Road",
    "suburb": "Sandhurst",
    "city": "Johannesburg",
    "province": "Gauteng",
    "postal_code": "2196"
}
```