Get insured information


API Refs

URI Parameters

userIdnumberinsure idyes

Response body

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
addressArray of objectsThe 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
preferencesobjectinsured’s notifications preferencesyes


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


paymentEmailsAllowedbooleanThe insured's communication preferences. If enabled, insureds will receive email notifications.yes
marketingEmailsAllowedbooleanThe insured's communication preferences. If enabled, insureds will receive email notifications about our new features.yes
paymentSMSAllowedbooleanThe insured's communication preferences. If enabled, insureds will receive sms text notifications.yes


  1. Get insured information Request;
  2. Get insured information Response:
      "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



You can only receive information about insureds that you created yourself through our API.


To get information about the insured's banks, go to Get list of insured’s banks

The information about insured includes general information, including addresses and notification settings.