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.

Recipes

Create Account response code 407-13

Open Recipe

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
48	`Preferred Name not supported for this product.` Resend without `preferredName` or `displayPreferredNameOnlyOnCard` in the request.
407-02	`Customer already has this product issued.` The product has already been created with this same `id` value. Check VLDLV for the level at which `id` must be unique.
407-03	`Invalid instant issue card`. An attempt was made to use an instant-issue card that has already been sold. Retry with an unissued instant-issue card number.
407-04	`Load amount outside of load limits`. Too much money is being loaded. Retry with an appropriate amount in `loadAmount`, or check your `maxLimit` and `minLimit` settings.
407-05	`Could not create account`. Contact Galileo for troubleshooting.
407-06	`Could not load card`. Contact Galileo for troubleshooting.
407-07	`Primary account is invalid`. The account number in `primaryAccount` cannot be an instant-issue card.
407-08	`Secondary accounts cannot be added to secondary accounts`.
407-09	`Maximum number of secondary accounts exceeded`. Product settings do not permit this many secondary accounts per primary account. Set SECLM on the secondary account to a higher number.
407-10	`ID type 2 is required as main ID for running CIP.` Product settings require `idType: 2` (SSN/SIN) to run Galileo's integrated customer ID verification. Pass a SSN in `id`. Controlled by VLDLV.
407-11	`Account created, ID validation failed`. Customer's personal info has failed the ID check. Take action depending on the result in the response: `F` — Fail. Take no action: the customer does not qualify for an account. `R` — Refer. Depending on your arrangements with Galileo, request valid documents from the customer or wait for Galileo's third-party CIP to complete.
407-12	`An application with the same ID has already been submitted`. Duplicate SSNs were used for enrollment. Follow your business plan for this outcome. Controlled by VLDLV.
407-13	`Application successfully started and CIP run`. The cipStatus parameter was set to 1, the application was successfully started, and CIP was run. An account was not created. Take action depending on the result in the response: `P` — Pass. Contact Galileo for instructions on creating the account. Do not run Create Account again. `F` — Fail. Take no action: the customer does not qualify for an account. `R` — Refer. Depending on your arrangement with Galileo, request valid documents from the customer or wait for Galileo's third-party CIP to complete.
407-14	`Success -- partial limit violation`. Only the amount permitted by product settings was loaded.
407-15	`Success -- delayed payment`. The account was created but funds were not loaded onto the card because of limit violations. An attempt will be made tomorrow to load the card.
407-16	`Card is marked as fraudulent.` Used for instant-issue cards which have been swiped before issuance. Retry with another instant-issue card.
407-17	`Card not allocated to your store for issuance`. The `location` does not match the location that this batch of cards was created for. Change the location on the account or retry with another instant-issue account number.
407-18	`Specified load from account number is invalid`. The `loadFromAccountNo` parameter contained an account number that does not exist in the Galileo system. Retry with valid account number.
407-19	`A load was attempted for a non-positive amount.` A negative load amount was passed. Retry with a positive amount.
407-20	`The prodId for the secondary account is not allowed`. Product parameters do not permit the `prodId` to be a secondary account for the account in `primaryAccount`. Check SECP on the primary account.
407-21	`Invalid real-time funding account`. `fundingAccountNo` must contain an RTF funding account.

Form Data

apiLogin

string

required

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

apiTransKey

string

required

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

providerId

int32

required

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

transactionId

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"

accountNo

string | null

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

idType

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"

idType2

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

id2

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"

idType3

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

id3

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"

locationType

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:

location

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"

locale

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:

externalAccountId

string | null

≤ 30

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"

firstName

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"

middleName

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"

lastName

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"

dateOfBirth

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"

address1

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"

address2

string | null

Account holder's second address line.
Pattern: Max 40 alphanumeric characters and address symbols
Example: "#4B"

address3

string | null

Account holder's third address line.
Pattern: Max 30 alphanumeric characters and address symbols
Example: "Carrera Central"

address4

string | null

Account holder's fourth address line.
Pattern: Max 30 alphanumeric characters and address symbols
Example: "Barrio El Alhambra"

address5

string | null

Account holder's fifth address line.
Pattern: Max 30 alphanumeric characters and address symbols
Example: "Piso 3"

city

string | null

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

state

string | null

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

postalCode

string | null

4 to 10

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

countryCode

string | null

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"

primaryPhone

string | null

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"

otherPhone

string | null

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"

mobilePhone

string | null

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"

mobileCarrierId

string | null

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

string | null

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

webUid

string | null

4 to 30

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"

webPwd

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"

secretQuestion

string | null

≤ 50

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?"

secretAnswer

string | null

≤ 50

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

incomeSource

string | null

2 to 60

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

occupation

string | null

2 to 60

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

nationality

string | null

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

placeOfBirth

string | null

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

curp

string | null

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

politicalAffiliation

int32 | null

0 to 1

Whether the account holder is a PEP.

1 — PEP
0 — Not a PEP.

kycRefNo

string | null

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

monthlyIncome

float | null

0 to 9999999999

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

externalCustomerId

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%-"

prodId

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

loadAmount

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

loadType

string | null

≤ 2

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"

primaryAccount

string | null

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"

fundingAccountNo

string | null

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

sharedBalance

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:

authorizedUser

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:

userData

string | null

≤ 50

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"

offline

int32 | null

enum

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

Allowed:

verifyOnly

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:

cipStatus

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:

embossLine2

string | null

≤ 28

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

providerAssessedFee

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

loadFromAccountNo

string | null

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"

sweepDate

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"

expressMail

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"

shipToAddressPermanent

string | null

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

shipToAddress1

string | null

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

shipToAddress2

string | null

≤ 40

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

shipToCity

string | null

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

shipToState

string | null

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

shipToPostalCode

string | null

4 to 10

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

shipToCountryCode

string | null

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"

businessName

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"

mobilePhoneCountryCode

string | null

2 to 4

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

response-content-type

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

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml