---
title: "Creates a address details entry for the agency candidate"
method: POST
path: "/agency/{agency_id}/candidate/{candidate_id}/address-details"
tags: ["Agency Candidate Address Details"]
---

# Creates a address details entry for the agency candidate

`POST /agency/{agency_id}/candidate/{candidate_id}/address-details`

## Request

- Base URL: `http://localhost:3010/v1`
- URL: `http://localhost:3010/v1/agency/{agency_id}/candidate/{candidate_id}/address-details`
- Auth: HTTP basic and HTTP basic and HTTP basic

## Request body

- CandidateAddressItemDef: address details item
  - `type` 'physical_address' | 'postal_address' | 'alternative_address', required
  - `address_line1` string, required
  - `address_line2` string
  - `city` string
  - `province` string
  - `country_code` string, required
  - `post_code` string, required

## Response `201`

Agency candidate address detail entry that was created

- AgencyCandidateAddressItemResponseDef: address details item
  - `type` 'physical_address' | 'postal_address' | 'alternative_address', required
  - `address_line1` string, required
  - `address_line2` string
  - `city` string
  - `province` string
  - `country_code` string, required
  - `post_code` string, required
  - `_id` string, required
  - `updated_at` string, date-time, required
  - `created_at` string, date-time, required
  - `__v` integer, required
  - `candidate_id` string, required
  - `agency_id` string, required
  - `co_ords` CoOrds: The geo-location information, co-ordinates
    - `longitude` number
    - `latitude` number
  - `geo_location_last_checked_at` string, date-time
  - `geo_location_details` object
    - `type` 'manual' | 'lookup' | 'lookup_failed'
    - `updated_at` string, date-time

## Other responses

- `400`: Validation errors caused by missing or invalid header / path or payloads
- `401`: Failed to authenticate the user making the request
- `403`: Permission denied error
- `default`: Server error occurred

---

[API](https://skmtc.dev/staffshift/apis/staffshift-api-gateway.md) - [All operations](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/revisions/1f079f6b65f5?raw)