Create an insured

📘

API Refs

Request body

NameTypeDescriptionRequired
addressobject
(Address table)
The insured’s physical mailing address. Providing a value here is only necessary if you want the user to be able to receive paper checks in the mail.no
bankInfoobject
(BankInfo table)
The insured's banking information that will be used for ACH transfers.no
emailstringThe user's email address. This value will be used for all future notifications and web-app logins for this user, so choose carefully.yes
firstNamestringThe user's legal first name.yes
lastNamestringThe user's legal last name.yes
businessNamestringThe user's business name, if applicable. Providing a value here will cause this user to be created as an Unverified Business type, otherwise they will be an Unverified Personal type.no

Address

NameTypeDescriptionRequired
aliasstringThe name of the address information. Will be used to deliver checks.yes
address1stringLegal address infoyes
address2stringAdditional optional legal address infono
citystringLegal city nameyes
postalCodenumber stringNumber string with 5 digits lengthyes
statestringState from values. See first *yes
phonestringLegal insured’s phone numberyes

states: AL, AK, AS, AZ, AR, CA, CO, CT, DC, DE, FL, GA, GU, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MP, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UM, UT, VT, VI, VA, WA, WV, WI, WY

BankInfo

NameTypeDescriptionRequired
routingNumbernumber stringA numeric string for the bank routing number corresponding to a US bank or credit union. The first two digits must be in a range from "01" through "12", or "21" through "32", and the string value must consist of nine digits.yes
accountNumbernumber stringA numeric string of 4-17 digits.yes
accountTypestringThe type of bank account this is must be one of these values: checking or savings.yes

Response body

NameTypeDescriptionRequired
idnumberCreated insured idyes

If it was not possible to add a bank when creating an insured

NameTypeDescriptionRequired
messagestringMessage about problemyes
datanumberCreated insured idyes

Example

  1. Create insured Request
    {
      "id": 1,
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Smith",
      "address": [
        {
          "address1": "11 Birch Hill Street",
          "address2": "Apt. 123",
          "city": "Bronx",
          "postalCode": "10023",
          "state": "NY",
          "phone": "123-456-7890",
          "alias": "Home"
        }
      ],
      "preferences": {
        "paymentEmailsAllowed": false,
        "marketingEmailsAllowed": false,
        "paymentSMSAllowed": false
      }
    }
    
  2. Create insured Response headers:
    {
      "id": 1
    }
    

Description

❗️

This process is the first and mandatory for any flow that involves ACH and Paper Check transfers.

❗️

Type of insured can’t be changed in the future.

📘

Note that in the API, you can only work with insureds you create through this endpoint.

Mandatory information

  • Email (unique);
  • First name;
  • Last name.

Additional information

  • Business name - for receive-only, it does not affect the logic of request execution in any way;
  • Insured’s address - required information for sending Paper Checks transfers;
  • Insured's bank - required information to send ACH transfers.