Skip to main content
POST
Centrelink Card

Authorizations

x-api-key
string
header
required

Use your API key in the x-api-key header.

Headers

Accept
string
default:application/json
Content-Type
string
default:application/json
x-api-key
string
required
Example:

"{your_api_key}"

Body

application/json
CustomerName
string
required

Name printed on the card.

Example:

"John Smith"

CardExpiry
object
required
BirthDate
object
required
CardType
enum<string>
required

Centrelink card type.

Available options:
PCC,
HCC,
SHC
Example:

"PCC"

CustomerReferenceNumber
string
required

Customer reference number.

Example:

"123456789X"

VerificationRequestNumber
string

Your unique identifier for this verification request. Defaults to a system-generated UUID if omitted.

Example:

"VI-01-01"

Response

200 - application/json

Request processed. Check VerificationResultCode to determine whether the verification was valid (1) or invalid (2); Errors is present only when invalid.

ActivityId
string

Unique identifier assigned by DVS to this verification activity.

Example:

"5a1626e0-272f-4a64-b085-1068a877701d"

OriginatingAgencyCode
string

Code of the agency that originated the verification request.

Example:

"IDM001"

VerificationRequestNumber
string

Echo of the request's VerificationRequestNumber.

Example:

"VI-01-01"

VerificationResultCode
enum<integer>

Result of the verification. 1 = Valid, 2 = Invalid.

Available options:
1,
2
Example:

1

Errors
object[]

Present only when the verification is invalid.