Update Enrollment

post

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

Use the Update Enrollment endpoint to update customer profile information for an enrollment that was created using Start Enrollment.

📘
Note
Validation on an SSN is limited to a length check.

Status codes

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

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

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

Primary identifier for an account holder. Galileo converts all letters to lowercase.
Pattern: See Customer ID Types
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

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"

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:

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: 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.
Pattern: Exactly 10 digits, no hyphens or other characters
Example: "8013656060"

otherPhone

string | null

Phone number.
Pattern: Exactly 10 digits, no hyphens or other characters
Example: "8013656060"

mobilePhone

string | null

Phone number.
Pattern: Exactly 10 digits, no hyphens or other characters
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

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"

monthlyIncome

float | null

0 to 9999999999

Defaults to 0

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

monthlyLiab

float | null

0 to 999999999999.99

Defaults to 0

Currency amount as a whole or decimal amount.
Pattern: Positive integer or decimal number
Example: 100.00, 100, or 100.73

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"

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

Status codes

default