API Reference

Create Account

post
https://api-{corename}.{env}.gpsrv.com/intserv/4.0/createAccount

Use the Create Account endpoint to create an account for a new customer. You can use this endpoint for personalized, instant issue, and secondary products.

This endpoint runs CIP if you are using Galileo's integrated CIP process. In contrast with the Start Enrollment endpoint, Create Account creates a customer record and at the same time creates an account. Depending on product settings, it also creates a card and loads funds onto it.

Consult the Creating an Account procedure for instructions on using this endpoint, and consult the Customer ID Verification guide for how to use this endpoint with Galileo's integrated CIP solution. The instructions include a flowchart to illustrate how Create Account works in the Galileo system. Also see Create Account vs Add Account in the About Accounts guide.

📘

Note

You can receive PCI-sensitive data only if your provider parameters permit it.

Duplicate use of customer ID

Galileo can configure your product parameters to allow or disallow the duplicate use of customer IDs such as SSNs across your programs. (If one of your prospective customers already has a product with another Galileo partner, no duplicate is detected.)

CIP response

If you are using Galileo's integrated CIP solution, the Create Account response includes the verdict. Consult Create Account and Create Virtual Account Process in the Customer ID Verification (CIP/KYC) guide for more information.

Test names in the CV environment

In the CV environment only, you can use specific names with the Create Account endpoint to trigger different CIP responses. For the firstName, middleName, and lastName parameters, use these values:

  • John F Smith — Triggers a CIP failure (F)
  • John R Smith — Triggers a CIP refer (R)
  • John P Smith — Triggers a CIP pass (P)

Do not use these test names in Production.

Required fields

Most input parameters for this endpoint are not required, to accommodate various use cases. If you would like some of the parameters to be required, populate the PINED product parameter with the parameters to be required. For example: idType,id.

If this endpoint returns a status code that does not match a status code that is specific to this endpoint, it may be an enrollment status code. See Enrollment Statuses for more information.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Form Data
string
required

Web service username, as provided by Galileo.
Pattern: Max 50 characters
Example: "AbC123-9999"

string
required

Web service password, as provided by Galileo.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

int32
required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

string
required
1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

string | null
^$|^([0-9]{12}|[0-9]{16})$

The PRN or PAN of the account.
Pattern: PAN or PRN
Example: "074103447228"

int32 | null
enum

Specifies the type of primary identifier in the id parameter. This parameter is required when id is populated. See the ID column in the Customer ID Types table for valid values.
Pattern: 1- or 2-digit integer
Example: 2

string | null

The value of the primary identifier that is specified in idType. Product settings determine whether thisPrimary ID for the account holder. This parameter is required when using Galileo's integrated CIP solution. Galileo converts all letters to lowercase.
Pattern: As specified in the Layout column of the Customer ID Types enumeration
Example: "123456789"

int32 | null
enum

Specifies the type of secondary identifier in the id2 parameter. This parameter is required when id2 is populated. See the ID column in the Customer ID Types table for valid values.
Pattern: 1- or 2-digit integer
Example: 1

string | null

The value of the secondary identifier that is specified in idType2. Galileo converts all letters to lowercase.
Pattern: As specified in the Layout column of the Customer ID Types enumeration
Example: "123456789012|ut|12/25/2020"

int32 | null
enum

Specifies the type of tertiary identifier in the id3 parameter. This parameter is required when id3 is populated. See the ID column in the Customer ID Types table for valid values.
Pattern: 1- or 2-digit integer
Example: 1

string | null

The value of the tertiary identifier that is specified in idType3. Galileo converts all letters to lowercase.
Pattern: As specified in the Layout column of the Customer ID Types enumeration
Example: "abc123456789|05-22-2027"

int32 | null
enum
Defaults to 0

Type of ID in location:

  • 0 — Galileo location ID
  • 1 — Partner location ID
  • 2 — Don't validate
  • 3 — Instant-issue location override. Valid for Create Account only. See Setup for Instant Issue for details.

Pattern: Integer
Example: 0

Allowed:
string | null

Unique location identifier (location) as returned by the Create Location endpoint. This value is also returned by the Get Locations endpoint depending on the value of locationType when the location was created:

  • 0 or 2 — Returned in the location_id field
  • 1 — Returned in the provider_specified_id field

Pattern: Integer if locationType: 0 or locationType: 2; max 15 characters if locationType: 1
Example: "a455-3483"

string | null
enum
Defaults to en_US

The account holder language and localization preference. Valid values are en_US, es_US, fr_CA, en_CA, es_MX, en_MX. If the account holder address is outside the U.S., pass a non _US value for this parameter to disable U.S. address validation.
Pattern: Letters with underscore
Example: "en_US"

Allowed:
string | null
≤ 30
^[A-Za-z0-9\-+/=_]*$

Identifier supplied by the provider, which is not related to the Galileo system. This ID is stored in the Galileo system in association with this account and can be provided in the RDFs.
Pattern: Max 30 alphanumeric characters. Lowercase only.
Example: "553b45sbs"

string | null
1 to 40

Account holder's first name. Special character support.
Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (')
Example: "Ed"

string | null
1 to 40

Account holder's middle name. Special character support.
Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (')
Example: "W"

string | null
1 to 40

Account holder's last name. Special character support.
Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (')
Example: "Harley"

date-time | null

Account holder's birth date. This date is compared with the DOB product parameter when there is a minimum age requirement on the account.
Pattern: YYYY-MM-DD
Example: "1980-01-01"

string | null

Account holder's first address line. Cannot be a P.O. box. Validation rules for address1.
Pattern: 4–40 alphanumeric characters
Example: "33 Maple Street"

string | null

Account holder's second address line. Character set for address lines.
Pattern: Max 40 characters
Example: "#4B"

string | null

Account holder's third address line. Character set for address lines.
Pattern: Max 30 characters
Example: "Carrera Central"

string | null

Account holder's fourth address line. Character set for address lines.
Pattern: Max 30 characters
Example: "Barrio El Alhambra"

string | null

Account holder's fifth address line. Character set for address lines.
Pattern: Max 30 characters
Example: "Piso 3"

string | null

Account holder's city.
Pattern: Max 30 characters: letters, spaces, hyphen and period
Example: "Salt Lake City"

string | null

Account holder's state or province.
Pattern: String
Example: "UT"

string | null
4 to 10
^[a-zA-Z0-9\-\ ]*$

Account holder's postal code (ZIP code).
Pattern: 1234, 12345, 12345-1234, or K1A-1A1
Example: "84121"

string | null
^\d{3}$

Account holder's country. Three-digit UN M49 code, such as 840 for USA, 124 for Canada, 484 for Mexico, 170 for Colombia.
Pattern: 3-digit number
Example: "840"

string | null
^([0-9]+)$

Account holder's primary phone number. When passing a value for this parameter, you must also pass mobilePhoneCountryCode.
Pattern: Validation according to the value in mobilePhoneCountryCode.
Example: "8015556060"

string | null
^([0-9]+)$

Account holder's secondary phone number. When passing a value for this parameter, you must also pass mobilePhoneCountryCode.
Pattern: Validation according to the value in mobilePhoneCountryCode.
Example: "8015556060"

string | null
^([0-9]+)$

Account holder's mobile phone number. When passing a value for this parameter, you must also pass mobilePhoneCountryCode.
Pattern: Validation according to the value in mobilePhoneCountryCode.
Example: "8015556060"

string | null

Account holder's mobile carrier. Configurable list.
Pattern: Configurable list
Example: "8"

string | null
[A-Za-z0-9À-öø-þŒœŠšŸŽž!-@\[-`{-~¡-¿÷€]+

Account holder's email.
Pattern: Email address, 3–63 characters
Example: "[email protected]"

string | null
4 to 30
^[a-zA-Z0-9]+(?:[_-][a-zA-Z0-9]+)*$

Account holder's username for the Galileo-hosted website. Must be unique across the program.
Pattern: Alphanumeric, with first character a letter; case insensitive
Example: "eharley"

string | null

Account holder's password for the Galileo-hosted website.
Pattern: Min 8 characters: must include upper-case character, lower-case character, and a number
Example: "4j9KH3kkdh"

string | null
≤ 50
^[\w\s\?\']*$

Account holder's secret question for the Galileo-hosted website.
Pattern: Max 50 characters: letters, spaces, ?
Example: "What was the name of your first pet?"

string | null
≤ 50

Account holder's answer to secretQuestion.
Pattern: Max 50 characters: letters, spaces, ?
Example: "Larry"

string | null
2 to 60
^[a-zA-Z0-9\|_\-@\.,' &]*$

Account holder's employer name or income source.
Pattern: Max 60 characters: alphanumeric, space, underscore, hyphen, period, @, & and comma.
Example: "Kroger Food & Drug"

string | null
2 to 60
^[a-zA-Z0-9\|_\-@\.,' &]*$

Account holder's occupation.
Pattern: Max 60 characters: alphanumeric, space, underscore, hyphen, period, @, & and comma.
Example: "Project Manager"

string | null

Account holder's nationality.
Pattern: 2-character ISO-3166-2 code
:Example: "MX"

string | null

Account holder's place of birth
Pattern: ISO-3166-2 subdivision code
Example: MX-YUC

string | null

Account holder's CURP
Pattern: 18 alphanumeric characters
Example: "HRGRAL82050602H900"

int32 | null
0 to 1

Whether the account holder is a PEP.

  • 1 — PEP
  • 0 — Not a PEP.
string | null

KYC reference number to track the KYC process for the account holder.
Pattern: 36 characters
Example: "KYC123456789012312312312521312312312"

float | null
0 to 9999999999

Monthly income for the account holder.
Pattern: Float between 0 and 9999999999
Example: 3400.00

string | null
≤ 512

Identifier supplied by the provider, which is not related to the Galileo system.
Pattern: Max 512 characters: all ASCII characters
Example: "acv#-@45!sbsxm%-"

int32
required
0 to 100000000

Galileo-generated identifier for a product. If this ID is for a business product then businessName is required.
Pattern: Integer
Example: 501

float | null
≥ 0

Currency amount passed as a whole or decimal amount. Initial load amount on a card must be within product load limits or be the designated amount for an instant-issue card.
Pattern: Float or integer
Example: 100.00, 100 or 100.73

string | null
≤ 2
^[a-zA-Z0-9]*$

Transaction type for the loadAmount. Use values from your Galileo-supplied list of load types. If no loadType is specified, the default type RL (retail load) is used.
Pattern: String
Example: "RL"

string | null
^[0-9]{12}$|^[0-9]{16}$

PAN or PRN of the primary account to associate this account with. Populate this parameter only when creating a secondary account.
Pattern: PAN or PRN
Example: "123456789012"

string | null
^$|^([0-9]{12})$

PRN of the RTF funding account. Required if prodId is an RTF spending product.
Pattern: 12-digit numeric string
Example: "143101204201"

int32 | null
enum

Specifies whether the secondary account will share the balance of the primary account. This parameter is required when primaryAccount is populated. Do not set this parameter to 1 when primaryAccount is not populated.

  • 0 — Do not share the balance
  • 1 — Share the balance

Pattern: Integer
Example: 1

Allowed:
int32 | null
enum

Specifies whether the account is an authorized user. This parameter requires primaryAccount and sharedBalance to be populated.

  • 0 — Do not mark this account as authorized user
  • 1 — Mark this account as authorized user

Pattern: Integer
Example: 1

Allowed:
string | null
≤ 50
^[a-zA-Z0-9_ ]*$

Data supplied by the provider, from sources external to the Galileo system. This data will be stored in the Galileo system in association with this account. The most common use of this parameter is to track affiliate-marketing traffic. The data in this field can be added to an RDF.
Pattern: Supported characters
Example: "a4434gg44"

int32 | null
enum

Pass 1 for an offline transaction.
Pattern: Integer
Example: 0

Allowed:
int32 | null
enum

Pass 1 to test the validity of the parameter data without committing the information to the Galileo system.
Pattern: Integer
Example: 0

Allowed:
string | null
enum

CIP setting override. Valid only if you are using Galileo's integrated CIP solution.

  • "0" or empty — Do not override the CIP setting.
  • "1" — Create the customer record and run CIP but do not create an account.
  • "2" — Create the customer record and account but do not run CIP.

Pattern: Numeric string
Example: "0"

Allowed:
string | null
≤ 28
^[a-zA-Z0-9_\s\'"!\?\-]*$

Second line to emboss on the card.
Pattern: Supported characters
Example: "Scarlet Ibis Shipping"

float | null
-0.001 to 999999999999.99

Fee amount assessed by the provider. This value is passed to Galileo only for informational purposes: passing this parameter does not assess the fee.
Pattern: Monetary amount greater than 0.
Example: 2.50

string | null
^[0-9]{12}$|^[0-9]{16}$

To load funds into the account at the time of account creation, specify the PAN or PRN of the source account for the funds. This account must be in the same program as the account being created.
Pattern: PAN or PRN
Example: "123456789012"

date-time | null

The last date that a daily sweep should be performed. This parameter is valid only if account sweeping is configured for the product.
Pattern: YYYY-MM-DD
Example: "2016-01-01"

string | null
enum

The type of shipping for the physical card associated with this account. These values are universal across all vendors:

  • 1 — Standard shipping
  • 2 — Express shipping
  • 4 — Bulk shipping

Legacy values Y = 2 and N = 1. Consult your emboss vendor for other values.
Pattern: String
Example: "2"

string | null
^(1|0)$

Pass 1 to always ship cards to the ship-to address instead of one time only.
Pattern: 1 or 0
Example: "1"

string | null

First ship-to address line.
Pattern: Max 40 characters
Example: "33 business parkway"

string | null
≤ 40

Second ship-to address line.
Pattern: Max 40 characters
Example: "Suite 400"

string | null

Ship-to city.
Pattern: Max 30 characters
Example: "Salt Lake City"

string | null

Ship-to state.
Pattern: String
Example: "UT"

string | null
4 to 10
^[a-zA-Z0-9\-\ ]*$

Ship-to ZIP or postal code.
Pattern: 1234, 12345, 12345-1234, K1A-1A1
Example: "841213333"

string | null
^[0-9]{3}$

Ship-to country. Three-digit UN M49 country code, such as 840 for USA, 124 for Canada, 484 for Mexico, 170 for Colombia.
Pattern: 3-digit number
Example: "840"

string | null

Account holder's business name. This field is required if prodId is a business product.
Pattern: 2-150 characters. See the supported character set.
Example: "Ed%26Ted"

string | null
2 to 4
^\+[0-9]*$

Account holder's mobile phone country code.
Pattern: A plus sign followed by 1–3 digits. See Phone Validation for valid values.
Example: "+1"

Headers
string
enum
Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Updated 5 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/xml

Updated 5 months ago

Did this page help you?