API Reference

This object represents a person within the core. Below is the full object with example values.

{
  "id": "123456",
  "firstName": "John",
  "lastName": "Doe",
  "gender": "MALE",
  "birthDate": "1990-05-15",
  "street": "123 Main St",
  "city": "Springfield",
  "state": "IL",
  "zipCode": "62704",
  "taxIdNumber": "123456789",
  "phone": {
    "primary": "5551234567",
    "alternate": ["5559876543", "5556543210"]
  },
  "email": {
  	"primary": "[email protected]",
    "work": "[email protected]"
  },
  "occupation": "Software Engineer",
  "branch": "BR001",
  "officer": "AA123",
  "notes": "Customer prefers communication via email. Has multiple accounts across branches.",
  "creationDate": "2023-01-01"
}

Some fields have specific requirements, which are detailed below.

FieldTypeRequirementsDescription
idStringDefined by core
taxIdNumberStringUsually a Social Security Number.
firstNameString
lastNameString
genderEnumMALE, FEMALE, NOT_SPECIFIED
birthDateStringISO 8601 as YYYY-MM-DD
streetString
cityString
stateString
zipCodeString
phone.primaryString10 digits, no country code or separators
phone.alternateList of StringList of phone numbers, formatted as 10 digits, no country code or separators
email.primaryString
email.workString
occupationString
notesString
creationDateStringISO 8601 as YYYY-MM-DD
branchStringInternal identifier, specific to a core/bank
officerStringInternal identifier, specific to a core/bank