Accounts and Cards

Start Enrollment

Use the Start Enrollment endpoint to initiate a new enrollment and run <glossary:CIP>. This endpoint is not integrated with <glossary:IVS>. This endpoint is different from <a href="ref:post_createaccount" target="_blank">Create Account</a> in that it creates a customer record but does not create an account or card.

📘 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 <a href="ref:api-reference-enrollment-statuses" target="_blank">Enrollment Statuses</a> for more information.

post/startEnrollment

Request

Base URL
api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
URL
api-{corename}.{env}.gpsrv.com/intserv/4.0/startEnrollment
Auth
none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

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

apiTransKeystring required

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

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

prodIdinteger required

A unique product identifier from SoFi Tech Solutions. If this ID is for a business product then businessName is required. Pattern: Integer Example: 501

idstring nullable

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 the SoFi Tech Solutions legacy <glossary:CIP> solution. The system converts all letters to lowercase. Pattern: As specified in the Layout column of the <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> enumeration Example: "123456789"

idType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 nullable

Specifies the type of primary identifier in the id parameter. This parameter is required when id is populated. See the idType column in the <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> table for valid values. Pattern: Integer Example: 2

id2string nullable

Secondary identifier for an account holder. The system converts all letters to lowercase. Pattern: See <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> Example: "123456789012|ut|12/25/2020"

idType20 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 nullable

Specifies the type of identifier in id2. This parameter is required when id2 is populated. See the idType column in the <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> table for valid values. Pattern: Integer Example: 1

locationstring nullable

Unique location identifier (location) as returned by the <a href="ref:post_createlocation" target="_blank">Create Location</a> endpoint. This value is also returned by the <a href="ref:post_getlocations" target="_blank">Get Locations</a> 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"

locationType0 | 1 | 2 nullable

Type of ID in location:

0 — SoFi Tech Solutions location ID
1 — Partner location ID
2 — Don't validate

Pattern: Integer Example: 1

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"

firstNamestring nullable

Account holder's first name. <a href="ref:api-reference-special-characters" target="_blank">Special character support</a>. Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (') Example: "Ed"

middleNamestring nullable

Account holder's middle name. <a href="ref:api-reference-special-characters" target="_blank">Special character support</a>. Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (') Example: "W"

lastNamestring nullable

Account holder's last name. <a href="ref:api-reference-special-characters" target="_blank">Special character support</a>. Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (') Example: "Harley"

dateOfBirthstring date-time nullable

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"

address1string nullable

Account holder's first address line. Cannot be a P.O. box. <a href="ref:api-reference-address1-validation" target="_blank">Validation rules for address1</a>. Pattern: 4–40 alphanumeric characters Example: "33 Maple Street"

address2string nullable

Account holder's second address line. Pattern: Max 40 alphanumeric characters and <a href="ref:api-reference-special-characters#address-symbols" target="_blank">address symbols</a> Example: "#4B"

address3string nullable

Account holder's third address line. Pattern: Max 30 alphanumeric characters and <a href="ref:api-reference-special-characters#address-symbols" target="_blank">address symbols</a> Example: "Carrera Central"

address4string nullable

Account holder's fourth address line. Pattern: Max 30 alphanumeric characters and <a href="ref:api-reference-special-characters#address-symbols" target="_blank">address symbols</a> Example: "Barrio El Alhambra"

address5string nullable

Account holder's fifth address line. Pattern: Max 30 alphanumeric characters and <a href="ref:api-reference-special-characters#address-symbols" target="_blank">address symbols</a> Example: "Piso 3"

citystring nullable

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

statestring nullable

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

postalCodestring nullable

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

countryCodestring nullable

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'0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | 'Y' | 'N' nullable

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"

primaryPhonestring nullable

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

otherPhonestring nullable

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

mobilePhonestring nullable

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

mobileCarrierIdstring nullable

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

emailstring email nullable

Account holder's email. This field is validated by Marshmallow. Pattern: Email address, 3–63 characters Example: "user@fakedomain.com"

webUidstring nullable

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

webPwdstring nullable

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

secretQuestionstring nullable

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

secretAnswerstring nullable

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

userDatastring nullable

Data supplied by the provider, from sources external to the system. This data will be stored in the 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 <glossary:RDF>. Pattern: Max 50 alphanumeric characters, spaces, and underscores Example: "abcd_1234"

verifyOnly0 | 1 nullable

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

monthlyIncomenumber float nullable

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

monthlyLiabnumber float nullable

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

runCip0 | 1 nullable

Specifies whether to run <glossary:CIP> on the customer. Valid only when using the SoFi Tech Solutions legacy CIP solution.

0 — Do not run CIP
1 — Run CIP

Pattern: Integer Example: 1

businessNamestring nullable

Account holder's business name. This field is required if prodId is a business product. Pattern: 2–150 characters. See the <a href="ref:api-reference-special-characters#businessname-parameter" target="_blank">supported character set</a>. Example: "Ed%26Ted"

mobilePhoneCountryCodestring nullable

Account holder's mobile phone country code. Pattern: A plus sign followed by 1–3 digits. See <a href="ref:api-reference-phone-validation" target="_blank">Phone Validation</a> for valid values. Example: "+1"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "prodId": 501,
  "id": "123456789",
  "idType": 2,
  "id2": "123456789012|ut|12/25/2020",
  "idType2": 1,
  "location": "a455-3483",
  "locationType": 1,
  "locale": "en_US",
  "firstName": "Ed",
  "middleName": "W",
  "lastName": "Harley",
  "dateOfBirth": "1980-01-01",
  "address1": "33 Maple Street",
  "address2": "#4B",
  "address3": "Carrera Central",
  "address4": "Barrio El Alhambra",
  "address5": "Piso 3",
  "city": "Salt Lake City",
  "state": "UT",
  "postalCode": "84121",
  "countryCode": "840",
  "expressMail": "2",
  "primaryPhone": "8013656060",
  "otherPhone": "8013656060",
  "mobilePhone": "8013656060",
  "mobileCarrierId": "8",
  "email": "user@fakedomain.com",
  "webUid": "eharley",
  "webPwd": "4j9KH3kkdh",
  "secretQuestion": "What was the name of your first pet?",
  "secretAnswer": "Larry",
  "userData": "abcd_1234",
  "verifyOnly": 1,
  "monthlyIncome": 25.5,
  "monthlyLiab": 25.5,
  "runCip": 1,
  "businessName": "Ed",
  "mobilePhoneCountryCode": "+1"
}

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

Changes

No recorded changes to this operation across all 2 revisions of this API.