API Reference
Log In
API Reference

Plans and Info Requests

Info requests, smart forms and plans, oh my!

As a Tenant, if, for example, you are a lawyer and need to get information from clients of yours, you can create an Info Request from the Console or Tenants API. This is essentially a template of what you will want your clients to fill out.


Example

Consider this: you need to renew a passport and you get to go through the joyous experience of filling out forms! In this case, the government is like the Tenant who needs to get specific information from you, the client.

The government has a blank form they've created that gives you the information you need for filling out the form, and asks for various bits of information in different places. They have just created an Info Request or Plan.


You can then specify Items (or in the API, Plan Items), which are the individual questions or segments of information you're asking for.


There are three Item types:

  1. Content, descriptions & instructions (content) – here, you're not expecting to get anything from the recipients. This could be information or instructions that you're providing to them as part of this request.
  2. Records, documents & files (record) – use this when you want the recipient to upload something.
  3. Field (field) – essentially any other item where you do want information from the recipients, where it should not be something they upload. There are lots of field options, including: text, various number formats, multiple choice, etc.

Once you've specified all the Items you want in your request, and you've finalized your blank form template, that's when we call it a Plan. To use the API to send out the form or Plan to recipients to have them fill it out, you'll need the planId of your newly created form.

Then you can deliver the plans to your clients' Drawers (sidedrawer). A version of the Plan residing in a client's Drawer is a Plan Request or Smart Form – it is specific to them. They can now fill out the Plan Request/Smart Form and you will get the information you need from them!


Example – continued

Now when you go to a government office and they give you the form to fill out, or when you go to the government website and download the form, you are getting your own specific copy of the Info Request. The form that you can start filling out is a Plan Request or Smart Form. A Plan Request is your form, specifically.