customer-account

account

create

sessionUuid The unique identifier that pertains to a particular session and is used to validate permissions

Data type: uuid
Required: yes
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

Identifier for tracking this API call

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

Data type: uuid
Required: yes
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

Must be a unique number

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 6
Max: 50

Data type: uuid
Required: yes
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36br

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes*
Min: 36
Max: 36

Value defining the desired custom logo for plastic(s) being ordered

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 1
Max: 50

Value defining the desired custom design for plastic(s) being ordered
Special characters allowed: dot (.), hyphen (-), underscore (_)

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 1
Max: 50

First name for prepaid account

Data type: string
Required: yes
Letters: yes
Numbers: no
Special: no
Min: 2
Max: 50

Middle name for prepaid account

Data type: string
Required: no
Letters: yes
Numbers: no
Special: no
Min: 2
Max: 50

Last name for prepaid account

Data type: string
Required: yes
Letters: yes
Numbers: no
Special: no
Min: 3
Max: 50

Name prefix for account

Data type: string
Required: no
Letters: yes
Numbers: no
Special: yes
Min: 2
Max: 5

Name suffix for prepaid account

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 2
Max: 5

Name to be embossed on plastic
Emboss name is required when reference number has not been provided.

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 2
Max: 50

Date of birth
YYYY-MM-DD
Requires leading zeros
requires hyphens

This value may be required for certain products

Data type: date
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 4
Max: 50

social security number

This value may be required for certain credit products

Data type: string
Required: conditional
Letters: no
Numbers: yes
Special: yes
Min: 3
Max: 50

Valid values:
Y / y / 1
N / n / 0

Data type: string
Required: yes
Letters: yes
Numbers: no
Special: no
Min: 1
Max: 1

Email Address

Data type: string
Required: yes
Letters: yes
Numbers: yes
Special: yes
Min: 3
Max: 50

Current valid value: '1' (USA)

Data type: string
Required: no
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 3

Allows dashes, spaces and parentheses ( )

Data type: string
Required: yes
Letters: no
Numbers: yes
Special: yes
Min: 3
Max: 20

Data type: string
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 2
Max: 20

Including but not limited to: Primary
- Home
- Cell
- Work
- Office

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: no
Min: 3
Max: 50

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 3
Max: 50

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 3
Max: 50

Data type: string
Required: no
Letters: yes
Numbers: no
Special: yes
Min: 2
Max: 50

Required value if country is USA or CAN.

For non USA or CAN countries that do not have a state, provide the same value provided for the 'city' in this field

Data type: string
Required: conditional
Letters: yes
Numbers: no
Special: yes
Min: 2
Max: 20

Allows dashes and spaces

For non USA or CAN countries that do not have a postal code, use '00000' as the value.

Data type: string
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 3
Max: 20

Defaults to 'USA' if no value is provided.

For non USA or CAN countries, please see 'state' and 'postalCode' field details for address specifics.

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 1
Max: 50

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 1
Max: 99

0 = no / 1 = yes
Default is set to 0

Data type: string
Required: yes
Letters: no
Numbers: yes
Special: no
Min: 1
Max: 1

Internal Id of the user that created the account

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 3
Max: 50

Location tracking (e.g. branch number)

Data type: string
Required: no
Letters: yes
Numbers: no
Special: no
Min: 3
Max: 50

Allows leading zeros

Data type: string
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 3
Max: 50

Allows leading zeros

Data type: string
Required: no
Letters: no
Numbers: yes
Special: yes
Min: 3
Max: 25

If brandUuid, fintechUuid, or fintechReferenceNumber is not provided, brandReferenceNumber must be provided

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: no
Min: 3
Max: 5

If productUuid has not been provided, productReferenceNumber must be provided

Data type: string
Required: no
Letters: yes
Numbers: no
Special: no
Min: 8
Max: 8

If associating a company with this account, option to pass in a companyReferenceNumber instead of companyUuid

Data type: varchar
Required: no
Letters: yes
Numbers: yes
Special: no
Min: 8
Max: 16

If brandUuid, brandReferenceNumber, or fintechUuid is not provided, fintechReferenceNumber must be provided

Data type: varchar
Required: no
Letters: yes
Numbers: yes
Special: no
Min: 5
Max: 5

If brandUuid, brandReferenceNumber, or fintechReferenceNumber is not provided, fintechUuid must be provided

Data type: uuid
Required: no
Letters: yes
Numbers: yes
Special: yes
Min: 36
Max: 36

Data type: string
Required: no
Letters: yes
Numbers: yes
Special: no
Min: 1
Max: 1

If product type is 'Credit', default is set to 'Paper'
If product type is 'Debit' and a value was provided, this input will be set to null

Data type: string
Required: no
Letters: yes
Numbers: no
Special: no
Min: 5
Max: 20