➕Create Address Document

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

Create Address Document

POST {{baseUrl}}/address-documents

Upload a Proof of Address Document for a given Customer and Address.

Request Body

Name	Type	Description
customer_id*	String	The UUID for a specific customer that gets generated and returned in the POST Create New Customer response.
address_id*	String	The UUID for a specific address that gets generated and returned in the POST Create New Address response. It ensures that the Address Document is uploaded to the correct address.
document	File	This needs to be a PDF document that the customer uploads as a proof of address. It needs to contain the customer's physical address that they created in the POST Create New Address call.

201: Created Address Document Created

```json
{
    "data": {
        "id": "{{addressDocumentId}}",
        "valid": false,
        "validated": null,
        "information": null,
        "document": {
            "id": 2959,
            "name": "cojhb_oct_2022.PDF",
            "type": "pdf",
            "url": "https://dev.apply.fincheck.co.za/fincheck/documents/coct_nik_oct_2022.PDF"
        },
        "address_id": "{{addressId}}"
    }
}
```

422: Unprocessable Entity CustomerId is Missing

```json
{
    "errors": {
        "customer_id": [
            "The customer id field is required."
        ]
    }
}
```

422: Unprocessable Entity AddressId is Missing

```json
{
    "errors": {
        "address_id": [
            "The address id field is required."
        ]
    }
}
```

201: Created Address Document Created - Without Address Document

```json
{
    "data": {
        "id": "{{addressDocumentID}}",
        "valid": false,
        "validated": null,
        "information": null,
        "document": null,
        "address_id": "{{accountId}}"
    }
}
```

422: Unprocessable Entity Invalid File Type

```json
{
    "errors": {
        "document": [
            "The document must be a file of type: pdf."
        ]
    }
}
```