The Q2 CorePro Developer Hub

Welcome to the Q2 CorePro developer hub. You'll find comprehensive guides and documentation to help you start working with the CorePro API as quickly as possible.

Get Started    

A customer represents a single end-user. Almost every action in CorePro requires a customerId to identify for whom the action is being performed. To correlate a customer in CorePro to a user in your system, you can:

  1. Pass your system's unique user ID into the tag property during customer creation. This allows you to use your system's ID to fetch the customer's CorePro data via /customer/getByTag
  2. Capture and store the unique customerId returned by CorePro after customer creation. You can then use /customer/Get to fetch the customer's CorePro data


customer Object

Property

Data Type (length)

Description

accessTypeCode

enum

The maximum level of access this customer can have. Possible
values:

  • FULL: Full Access. Vetted customer
  • ACCT: Account Holder. Non-vetted customer
  • CARD: Card Holder. Non-vetted customer
  • FDRY: Fiduciary. Non-vetted customer

See customer.accessTypeCode for more details

accounts

array

An array of account objects owned by the customer

addresses

array

An array of address objects associated with the customer

birthDate

datetime

Example: 1976-07-04T00:00:00.000+00:00

cards

array

An array of card objects owned by the customer

createdDate

datetime

Date the customer was created. Note: a customer may have
been created but not available for use, depending on the
isLocked or status properties.

culture

enum

Accepted values vary by program. i.e.:

  • en-US: English
  • es-US: Spanish

customField1

string (50)

A property for holding client-defined data. There is no
business logic in CorePro for a custom field

customField2

string (50)

A property for holding client-defined data. There is no
business logic in CorePro for a custom field

customField3

string (50)

A property for holding client-defined data. There is no
business logic in CorePro for a custom field

customField4

string (50)

A property for holding client-defined data. There is no
business logic in CorePro for a custom field

customField5

string (50)

A property for holding client-defined data. There is no
business logic in CorePro for a custom field

customerId

integer

The CorePro-assigned unique ID for a customer. Will be
returned via /customer/create . Used as a parameter to
almost every other CorePro route

deceasedDate

datetime

Denotes the date the customer was reported as deceased.
i.e.: 2014-01-01T00:00:00.000+00:00

driversLicenseExpireDate

datetime

Date the driver's license expires. i.e.:
1976-07-04T00:00:00.000+00:00

driversLicenseIssueDate

datetime

Date the driver's license was issued. i.e.:
1976-07-04T00:00:00.000+00:00

driversLicenseNumber

string (30)

The identifying number from a government-issued driver's
license

driversLicenseNumberMasked

string

Last 4 digits of the driversLicenseNumber property value,
preceded by 6 '*'. i.e.: ******1234

driversLicenseState

string (2)

State from which the driver's license is issued. i.e.: IA
for Iowa

emailAddress

string (255)

Example: [email protected]

externalAccounts

array

An array of externalAccount objects owned by the customer

firstName

string (64)

First (given) name

gender

enum

Possible values:

  • M: Male
  • F: Female
  • U: Unknown/Unspecified

isActive

deprecated

Use status instead

isDocumentsAccepted

boolean

Only required when creating a new customer. Confirms that
customer viewed and accepted all documents returned via the
/bankDocument/list route

isLocked

boolean

Denotes if a customer is locked, typically caused by fraud
prevention mechanisms or manual intervention via the admin
console. A locked customer can not transfer any funds

isOptedInToBankCommunication

boolean

Denotes if customer opts in to receiving marketing
notifications from the bank. Note: customer may possibly
still receive other required notifications from the bank
regardless of this flag -- it depends on your program and
the bank.

isSubjectToBackupWithholding

boolean

All customers need to indicate whether they are subject to
backup withholding. CorePro will withhold the appropriate
percentage of earned interest and submit these funds
directly to the IRS. The amount withheld will be reported
on the annual 1099-INT generated by CorePro. Please see the
Backup Withholding topic at the IRS website for additional
details

lastActivityDate

datetime

Timestamp for the last time any action was performed on this
customer. Actions include listing, editing, archiving,
closing, transferring funds, or otherwise "touching" any
data specific to this customer, whether it is via the API, a
Bulk Transfer Request file, or the Admin console

lastModifiedDate

datetime

Date when the object was last altered in any way

lastName

string (128)

Last name (surname)

lockedDate

datetime

Denotes the last time isLocked was set to true. Note: if
isLocked is changed to false, this value will not reset.

i.e.: 2014-01-01T00:00:00.000+00:00

lockedReason

string

The reason isLocked was set to true. Freeform. Note: if
isLocked is changed to false, this value will not reset.

middleName

string (64)

passportCountry

string (5)

Country from which the passport is issued. i.e.:

  • US: United States

passportExpireDate

datetime

Date the passport expires. i.e.:
1976-07-04T00:00:00.000+00:00

passportIssueDate

datetime

Date the passport was issued. i.e.:
1976-07-04T00:00:00.000+00:00

passportNumber

string (30)

The identifying number from a government-issued passport

passportNumberMasked

string

Last 4 digits of the passportNumberMasked property,
preceded by 6 '*'. i.e.: ******1234

phones

array

An array of phone objects associated with the customer

status

enum

Possible values:

  • Active
  • Initiated
  • Manual Review
  • Verified
  • Denied
  • Expired
  • Archived
  • Deceased

suffix

string (20)

A customer's name suffix. i.e.:

  • Sr.
  • Esq.
  • Ph.D

tag

string (50)

A client-assigned unique identifier to represent exactly
one customer in CorePro in production. Sandbox does
allow duplicate tags for testing. Typically represents
the unique user ID in your system

taxId

string (30)

SSN in the US. Specify only the digits, no formatting (dashes,
spaces, etc.) of any kind.

taxIdMasked

string

Last 4 digits of the taxId property, preceded by 6
'*'. i.e.: ******1234

Updated 3 months ago

Customer


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.