Consumers

Consumer object

{
    "id": "consumer_Aa1ABb2BCc3CDd4DEe5EFf6FGg7GHh8H",
    "company_name": "ACME Inc.",
    "date_of_birth": "1970-01-01",
    "email_address": "jane.doe@example.com",
    "email_address_is_verified": true,
    "external_customer_id": "example",
    "first_name": "Jane",
    "last_name": "Doe",
    "phone_number": "5555551234",
    "phone_number_is_verified": false
}

Data	Data type	Description
`id`	string	Permanent unique identifier of the consumer.
`company_name`	string	Optional field for company name.
`date_of_birth`	string	Consumer’s date of birth in format `YYYY-MM-DD`.
`email_address`	string	An email address belonging to the consumer.
`email_address_is_verified`	boolean	A boolean (false, true) indicating whether `email_address` has been verified.
`external_customer_id`	string	A string representation of the consumer’s id in your system.
`first_name`	string	Consumer’s first name.
`last_name`	string	Consumer’s last name.
`phone_number`	string	A phone number belonging to the consumer.
`phone_number_is_verified`	boolean	A boolean (false, true) indicating whether `phone_number` has been verified.

Consumer field restrictions

Field	Restrictions	Min Size	Max Size
`company_name`	Alphanumeric and special characters. Must contain only uppercase letters (`A-Z`), lowercase letters (`a-z`), numbers (`0-9`), period (`.`), apostrophe (`'`), dash (`-`), comma (`,`), colon (`:`), brackets (`()`), exclamation (`!`), number (`#`), at (`@`), slashes (`\ /`), and spaces.	–	40
`date_of_birth`	Must be format – `YYYY-MM-DD`	–	10
`email_address`	Alphanumeric. Must contain `@` and `.`	–	50
`external_customer_id`	Alphanumeric and special characters, except percent signs.	–	30
`first_name`	Alphanumeric and special characters. Must contain only uppercase letters (`A-Z`), lowercase letters (`a-z`), numbers (`0-9`), period (`.`), dash (`-`), comma (`,`), and spaces.	–	25
`last_name`	Alphanumeric and special characters. Must contain only uppercase letters (`A-Z`), lowercase letters (`a-z`), period (`.`), apostrophe (`'`), dash (`-`), comma (`,`), and spaces.	–	25
`phone_number`	Must be 10 digits Area Code cannot start with ‘0’ or ‘1’ Digits 1-3 cannot be ‘000’ Digits 4-6 cannot be ‘555’ Cannot be ‘999-999-9999’ Cannot be ‘000-000-0000’	10	10

Read Consumer

Success

Request

GET /api/consumers/{consumer_id}
Authorization: Bearer {SECRET_KEY}

Example curl request

curl https://bankpay.certegy.com/api/consumers/consumer_Aa1ABb2BCc3CDd4DEe5EFf6FGg7GHhH \
-H 'Accept: application/json' \
-H 'Authorization: Bearer secret_Aa1ABb2BCc3CDd4DEe5EFf6FGg7GHhH'

Response The data property is a Consumer object.

HTTP/1.1 200 OK

{
    "data": {
        "date_of_birth": "1970-01-01",
        "email_address": "john.doe@example.com",
        "email_address_is_verified": true,
        "external_customer_id": "example",
        "first_name": "John",
        "full_name": "John Doe",
        "id": "consumer_Aa1ABb2BCc3CDd4DEe5EFf6FGg7GHhH",
        "last_name": "Doe",
        "phone_number": "8135551234",
        "phone_number_is_verified": true
    },
    "meta": {
        "type": "consumer"
    }
}

Example Errors

Consumer not found

Request

GET /api/consumers/{consumer_id}
Authorization: Bearer {SECRET_KEY}

Response

HTTP/1.1 200 OK

{
    "message": "not_found"
}

BankPay

BankPay

Consumer object

Consumer field restrictions

Read Consumer

Success

Example Errors

Consumer not found

BankPay

BankPay

Consumer object

Consumer field restrictions

Read Consumer

Success

Example Errors

Consumer not found

How can we help?