API Documentation

# Get Dependent v2.0Beta

The Get Dependent endpoint retrieves the details for a dependent. The request will return a single dependent.

# Request

GET /v2.0/customers/{profileKey}/dependents/{key}

# Authorization

An OAuth 2.0 Bearer token with the Profile.Read scope is required. For more information, see Authentication.

# Path Parameters

A list of the supported path parameters is described below.

Name Required Type Description
profileKey true guid The profile key for the customer. This value can be retrieved from the profileKey claim in the token returned from our SSO solution.
key true guid The key for the dependent.

# Response

200
OK
Returns a Dependent resource wrapped in an ApiResponse envelope.

# Response Body

The endpoint returns our ApiResponse envelope. The data property of the response will contain a Dependent resource.

# Sample

{
    "message": "The operation succeeded!",
    "notifications": [],
    "data": {
        "key": "e22afacc-bb1g-4d3d-95c4-f7184afcc355",
        "profileKey": "25b7726e-8416-5b13-a54a-b7fae6518b8g",
        "profileBrandGroupKey": "TEST-SPUR-PROFILE",
        "firstName": "Adam",
        "lastName": "Jones",
        "gender": "Male",
        "birthDate": "2011-06-06T00:00:00",
        "age": 10,
        "nextBirthdayOn": "2022-06-06T00:00:00",
        "daysToNextBirthday": 294,
        "customerRelationship": "Father"
    }
}

# Errors

The standard error responses apply.

401
Unauthorized
When authentication fails.
403
Forbidden
When authorisation fails.
404
Not Found
When the customer profile cannot be found.
404
Not Found
When the dependent cannot be found.

← Add Dependent →