Skip to content
BC Government LogoAddress Change

List address-change requests

GET
/api/v1/address-change
curl --request GET \
  --url https://address-change-test.apps.gold.devops.gov.bc.ca/api/v1/address-change \
  --header 'Authorization: Bearer <token>'

Returns the address-change requests owned by the authenticated resident, including the delivery status of each partner operation.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The request completed successfully.

Media typeapplication/json
Array<object>
object
requestId
required
string format: uuid
status
required
string
effectiveDate
required
string
nullable
createdAt
required
string format: date-time
submittedAt
required
string format: date-time
nullable
updatedAt
required
string format: date-time
operations
required
Array<object>
object
partnerCode
required
string
deliveryMode
required
string
status
required
string

Example 

[
  {
    "requestId": "7c825573-3df5-4e63-b376-ef7a4057369d",
    "status": "SUBMITTED",
    "effectiveDate": "2026-02-01",
    "createdAt": "2026-01-15T17:30:00.000Z",
    "submittedAt": "2026-01-15T17:30:00.000Z",
    "updatedAt": "2026-01-15T17:30:00.000Z",
    "operations": [
      {
        "partnerCode": "ICBC",
        "deliveryMode": "API",
        "status": "DELIVERED"
      }
    ]
  }
]

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"
}

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"
}