BODY

available_credit

• number (18,2)

• Customer’s open to buy

BODY

account_number

• number (14)

• The Account Number of the Customer

• This is not the VCC (Flexiti Card)

BODY

customer_id

• number (12)

• ID of the customer

• This is not the customer’s Account Number

BODY

security_qid.id

• ASCII string

• Customer’s Security Question ID provided by the Customer Lookup service

BODY

security_qid.text

• ASCII string

• Customer’s Security Question

BODY

address_1

• ASCII string (250)

• Customer Address Line 1

BODY

address_2

• ASCII string (100)

• Customer Address Line 2

BODY

city

• ASCII string (100)

• Customer City

BODY

postal_code

• ASCII string (10)

• Customer Postal Code

BODY

province

• ASCII string (2)

• Customer Province (2 character syntax, ex. ON for Ontario)

• Available values: AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, QC, SK, YT.

BODY

payment_protection

• boolean

• Whether the customer has insurance on the account

BODY

risk_rating

• ASCII string (4)

• Risk rating of the Customer

• Possible values: L, M, H, XH, XXH, XXXH

  • L - Low

  • M - Medium

  • H - High

  • XH - X-High

  • XXH - XX-High

  • XXXH - XXX-High

BODY

offer_types.plan_name

• ASCII string

• Name of the promotional plan available to the customer

BODY

offer_types.plan_id

• number (3)

• ID of the promotional plan available to the customer

BODY

offer_types.offer_category

• ASCII string

• Category of the promotional plans available to the customer

• Available values: equal_billing, deferred_payment

BODY

offer_types.term_options

• number (3)

• terms of the promotional plan available to the customer

BODY

preferred_language

• ASCII string (5)

• Preferred Language (Locale)

• Available values: en-CA, fr-CA

• Default value: en-CA

HEADER

bearer token

Yes

• ASCII string (1000)

• This is the word “Bearer” with a space and then the access_token given in oauth/token API response

• Default value: Bearer {insert_bearer_token_from_oauth_here/token_api}

PATH

client_id

Yes

• ASCII string (100)

• This is the Client ID given in the Developer User Account section

PATH

account_number

Yes

• number (14)

• This is the Customer ID retrieved in any of the available endpoints

BODY

format

Yes

• ASCII string

• Verification format to be presented to the Customer

• Available values: sms, email, merchant_override, security_question

• Default value: sms

BODY

security_qid

Required for format: security_question

• ASCII string

• Customer’s Security Question ID provided by the Customer Lookup service

BODY

security_answer

Required for format: security_question

• ASCII string

• Customer’s response to the Security Question

HEADER

bearer token

Yes

• ASCII string (1000)

• This is the word “Bearer” with a space and then the access_token given in oauth/token API response

• Default value: Bearer {insert_bearer_token_from_oauth_here/token_api}

PATH

client_id

Yes

• ASCII string (100)

• This is the Client ID given in the Developer User Account section

BODY

code

Yes

• ASCII string

• PDF417 code with driver licence information