Start Enrollment

post

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

Use the Start Enrollment endpoint to initiate a new enrollment and run CIP. This endpoint is different from Create Account in that it creates a customer record but does not create an account or card.

Consult the Customer ID Verification guide for instructions on using this endpoint with Galileo's integrated CIP solution.

📘
Note
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

Time	Status	User Agent
Retrieving recent requests…

Loading…

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"

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

string | null

The value of the primary identifier that is specified in idType. Product settings determine whether this ID should be unique across the program or product. 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"

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: Integer
Example: 2

id2

string | null

Secondary identifier for an account holder. Galileo converts all letters to lowercase.
Pattern: See Customer ID Types
Example: "123456789012|ut|12/25/2020"

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

location

string | null

≤ 20

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"

locationType

int32 | null

enum

Type of ID in location:

0 — Galileo location ID
1 — Partner location ID
2 — Don't validate

Pattern: Integer
Example: 1

Allowed:

locale

string | null

enum

Defaults to en_US

The account holder language and localization preference. 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: String
Example: "en_US"

Allowed:

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. Character set for address lines.
Pattern: Max 40 characters
Example: "#4B"

address3

string | null

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

address4

string | null

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

address5

string | null

Account holder's fifth address line. Character set for address lines.
Pattern: Max 30 characters
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

^[a-zA-Z0-9\-\ ]*$

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

countryCode

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"

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"

primaryPhone

string | null

^([0-9]+)$

Account holder's primary phone number.
Pattern: Validation according to the value in mobilePhoneCountryCode.
Example: "8013656060"

otherPhone

string | null

^([0-9]+)$

Account holder's secondary phone number.
Pattern: Validation according to the value in mobilePhoneCountryCode.
Example: "8013656060"

mobilePhone

string | null

^([0-9]+)$

Account holder's mobile phone number.
Pattern: Validation according to the value in mobilePhoneCountryCode.
Example: "8013656060"

mobileCarrierId

string | null

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

string | null

Account holder's email. This field is validated by Marshmallow.
Pattern: Email address, 3–63 characters
Example: "[email protected]"

webUid

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"

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

^[A-Za-z0-9_\'\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?"

secretAnswer

string | null

≤ 50

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

userData

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: Max 50 alphanumeric characters, spaces, and underscores
Example: "abcd_1234"

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: 1

Allowed:

monthlyIncome

float | null

0.01 to 999999999999.99

Currency amounts passed as whole or fractional amounts, examples: '100.00', '100', or '100.73'.
Pattern: Monetary amount 0 or greater.
Example: 25.50

monthlyLiab

float | null

0.01 to 999999999999.99

Currency amounts passed as whole or fractional amounts, examples: '100.00', '100', or '100.73'.
Pattern: Monetary amount 0 or greater.
Example: 25.50

runCip

int32 | null

enum

Specifies whether to run CIP on the customer. Valid only when using Galileo's integrated CIP solution.

0 — Do not run CIP
1 — Run CIP

Pattern: Integer
Example: 1

Allowed:

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

^\+[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

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

Loading…

Response

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

application/json

application/xml

default