Skip to content
BC Government LogoAddress Change

Save an address-change draft

PUT
/api/v1/address-change/drafts
curl --request PUT \
  --url https://address-change-test.apps.gold.devops.gov.bc.ca/api/v1/address-change/drafts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "idempotencyKey": "draft-7f3a", "draft": { "step": 2, "values": { "firstName": "Alex" } } }'

Creates or updates the resident draft identified by the idempotency key. The draft content is opaque form state and is stored encrypted.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

The address-change payload.

Media typeapplication/json
object
idempotencyKey
required
string
>= 1 characters <= 255 characters
draft
required
object
step
required
integer
<= 10
values
required
object
key
additional properties
any

Example 

{
  "idempotencyKey": "draft-7f3a",
  "draft": {
    "step": 2,
    "values": {
      "firstName": "Alex"
    }
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

The request completed successfully.

Media typeapplication/json
object
requestId
required
string format: uuid

Example 

{
  "requestId": "7c825573-3df5-4e63-b376-ef7a4057369d"
}

400

Section titled “400”

The request is malformed or fails validation. The body is an RFC 9457 problem details object; errors lists the invalid fields without echoing their values.

Media typeapplication/json
object
type
required
string
title
required
string
status
required
integer
detail
required
string
errors
required
Array<object>
>= 1 items
object
type
required
string
code
required
string
message
required
string
location
required
string
Allowed values: body query header path cookie

Example 

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid request body",
  "errors": [
    {
      "type": "validation",
      "code": "invalid_string",
      "message": "Invalid value at /person/dateOfBirth",
      "location": "body"
    }
  ]
}

401

Section titled “401”

A valid bearer access token is required.

Media typeapplication/json
object
statusCode
required
number
message
required
string
error
required
string

Example 

{
  "statusCode": 401,
  "message": "A bearer access token is required",
  "error": "Unauthorized"
}

403

Section titled “403”

The access token does not include the required scope.

Media typeapplication/json
object
statusCode
required
number
message
required
string
error
required
string

Example 

{
  "statusCode": 403,
  "message": "Missing address-change submission permission",
  "error": "Forbidden"
}

409

Section titled “409”

The request conflicts with the current state of a resource.

Media typeapplication/json
object
statusCode
required
number
message
required
string
error
required
string

Example 

{
  "statusCode": 409,
  "message": "An address-change request is already active",
  "error": "Conflict"
}

503

Section titled “503”

The service or a downstream partner is temporarily unavailable.

Media typeapplication/json
object
statusCode
required
number
message
required
string
error
required
string

Example 

{
  "statusCode": 503,
  "message": "Request could not be saved",
  "error": "Service Unavailable"
}