Get insured information

📘

API Refs

• Production: Get insured information
• Staging: Get insured information

URI Parameters

Name	Type	Description	Required
userId	number	insure id	yes

Response body

Name	Type	Description	Required
email	string	The user's email address. This value will be used for all future notifications and web-app logins for this user, so choose carefully.	yes
firstName	string	The user's legal first name.	yes
lastName	string	The user's legal last name.	yes
businessName	string	The 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	Array of objects	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
preferences	object	insured’s notifications preferences	yes

Address

Name	Type	Description	Required
alias	string	The name of the address information. Will be used to deliver checks.	yes
address1	string	Legal address info	yes
address2	string	Additional optional legal address info	no
city	string	Legal city name	yes
postalCode	number string	Number string with 5 digits length	yes
state	string	State from values. See first *	yes
phone	string	Legal insured’s phone number	yes

Preferences

Name	Type	Description	Required
paymentEmailsAllowed	boolean	The insured's communication preferences. If enabled, insureds will receive email notifications.	yes
marketingEmailsAllowed	boolean	The insured's communication preferences. If enabled, insureds will receive email notifications about our new features.	yes
paymentSMSAllowed	boolean	The insured's communication preferences. If enabled, insureds will receive sms text notifications.	yes

Example

1. Get insured information Request;
2. Get insured information Response:
   JSON

   {
     "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
     }
   }
   

Description

❗️

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.