Quickstart

12min
Screening concepts
Verification Template
Templates are a way to configure the application process. A template defines the set of verifications that will be included in an application. It sets the application cost for applicants and co-signers. It also allows to define a flexible decisioning criteria and automate some aspects of application processing. Templates can only be created, updated, and assigned to properties via the Boom partner platform (e.g., not programmatically).
Properties
Properties contains units and have an associated verification template. There are property level magic link to create a link for units available at a specific property.
Units
A unit belongs to a property. Applicants are able to apply for specific units.
Magic Links
A magic link is a URL to share with your applicants. Links can be to apply for a specific unit, a property, or for your portfolio. Unit level link allows an applicant to apply for that specific unit. Property level link allows user to chose a unit within a specific property and apply for it. Portfolio level link allows applicants to apply fir any unit at any listed property.
Applications
Applications submitted by applicants will contain two types of data where applicable by local tenant screening laws: self-attested and consumer report data. Self-attested data is information that the applicant directly reports (e.g., "Do you have any vehicles"). Consumer report data includes credit report and score, criminal background report, housing history report, eviction report, and others. Reports generated for an application are determined by the settings you set in the verification template assigned to the property. Applcations with criteria also contain a decision recommendation based on if the application met your criteria.
Authentication
1. In the Boom Partner Platform, generate an access key and a secret key.
2. Exchange your access key and secret key for an API token.
Curl
curl --location --request POST 'https://api.sandbox.boompay.app/partner/v1/authenticate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "sample-access-key",
    "secret_key": "sample-secret-key"
}'
curl --location --request POST 'https://api.sandbox.boompay.app/partner/v1/authenticate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_key": "sample-access-key",
    "secret_key": "sample-secret-key"
}'
﻿
With API token you are fully authenticated to execute api calls again partner API
Curl
curl --request GET \
  --url https://api.sandbox.boompay.app/partner/v1/magic_links \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json'
curl --request GET \
  --url https://api.sandbox.boompay.app/partner/v1/magic_links \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json'
﻿
Integration example
Property creation
Once template is created, we create a property and associate template id with it
JS
const verification_template_id = verification_template_response.data.id;

const property_response = await axios.post(
  'https://api.sandbox.boompay.app/partner/v1/properties',
  {
    name: 'My property',
    address: {
      address1: '123 Main St',
      address2: 'Apt 123',
      city: 'San Francisco',
      state_or_province: 'CA',
      postal_code: '12345',
    },
    verification_template_id: '1234567890',
    units: [
      {
        title: 'Unit 1',
        monthly_rent_amount: {
          cents: 100,
          currency: 'USD',
        },
        occupied: false,
        available_at: '2021-01-01',
      },
    ],
  },
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);
const property_application_link =
  property_response.data.magic_link.application_link;

const unit_application_link =
  property_response.data.units[0].magic_link.application_link;
const verification_template_id = verification_template_response.data.id;

const property_response = await axios.post(
  'https://api.sandbox.boompay.app/partner/v1/properties',
  {
    name: 'My property',
    address: {
      address1: '123 Main St',
      address2: 'Apt 123',
      city: 'San Francisco',
      state_or_province: 'CA',
      postal_code: '12345',
    },
    verification_template_id: '1234567890',
    units: [
      {
        title: 'Unit 1',
        monthly_rent_amount: {
          cents: 100,
          currency: 'USD',
        },
        occupied: false,
        available_at: '2021-01-01',
      },
    ],
  },
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);
const property_application_link =
  property_response.data.magic_link.application_link;

const unit_application_link =
  property_response.data.units[0].magic_link.application_link;
﻿
Unit creation
Property gets created with at least one unit defined. It is possible to add an additional unit to an existing property.
JS
const unit_response = await axios.post(
  'https://api.sandbox.boompay.app/partner/v1/units',
  {
    title: 'Unit 1',
    property_id: 1,
    monthly_rent_amount: {
      cents: 1000_00,
      currency: 'USD',
    },
    occupied: false,
    available_at: '2024-06-01',
  },
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);

const unit_application_link = unit_response.data.magic_link.application_link;
const unit_response = await axios.post(
  'https://api.sandbox.boompay.app/partner/v1/units',
  {
    title: 'Unit 1',
    property_id: 1,
    monthly_rent_amount: {
      cents: 1000_00,
      currency: 'USD',
    },
    occupied: false,
    available_at: '2024-06-01',
  },
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);

const unit_application_link = unit_response.data.magic_link.application_link;
﻿
Handle Magic Links
Unit, property or portfolio level link can be fetched and shared with potential tenants. Links can be deactivated or activated any moment depends on the needs or availability
JS
const portfolio_response = await axios.get(
  'https://api.sandbox.boompay.app/partner/v1/magic_links',
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);

const portfolio_link = portfolio_response.data.magic_link.application_link;

const deactivate_magic_link_response = await axios.patch(
  'https://api.sandbox.boompay.app/partner/v1/magic_links/1',
  {
    active: false,
  },
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);

const activate_magic_link_response = await axios.patch(
  'https://api.sandbox.boompay.app/partner/v1/magic_links/1',
  {
    active: true,
  },
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);
const portfolio_response = await axios.get(
  'https://api.sandbox.boompay.app/partner/v1/magic_links',
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);

const portfolio_link = portfolio_response.data.magic_link.application_link;

const deactivate_magic_link_response = await axios.patch(
  'https://api.sandbox.boompay.app/partner/v1/magic_links/1',
  {
    active: false,
  },
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);

const activate_magic_link_response = await axios.patch(
  'https://api.sandbox.boompay.app/partner/v1/magic_links/1',
  {
    active: true,
  },
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);
﻿
Process Applications
Once potential tenant submit an application, it is possible to fetch and find all reports and criteria based recommendation attached to it.
JS
const applications_response = await axios.get(
  'https://api.sandbox.boompay.app/partner/v1/applications',
  {
    params: {
      page: 1,
      per_page: 20,
    },
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);

const verification_response = await axios.get(
  'https://api.sandbox.boompay.app/partner/v1/applications/1/applicants/1/verifications/1',
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);

const report = verification_response.data.report;
const applications_response = await axios.get(
  'https://api.sandbox.boompay.app/partner/v1/applications',
  {
    params: {
      page: 1,
      per_page: 20,
    },
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);

const verification_response = await axios.get(
  'https://api.sandbox.boompay.app/partner/v1/applications/1/applicants/1/verifications/1',
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);

const report = verification_response.data.report;
﻿
Make Decision
Once decision made it is submitted back to the system.
JS
const approve_application_response = await axios.post(
  'https://api.sandbox.boompay.app/partner/v1/applications/1/approve',
  {
    skip_sending_email: false,
  },
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);

const reject_application_response = await axios.post(
  'https://api.sandbox.boompay.app/partner/v1/applications/1/reject',
  {
    reasons: ['reason'],
    skip_sending_email: true,
  },
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);
const approve_application_response = await axios.post(
  'https://api.sandbox.boompay.app/partner/v1/applications/1/approve',
  {
    skip_sending_email: false,
  },
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);

const reject_application_response = await axios.post(
  'https://api.sandbox.boompay.app/partner/v1/applications/1/reject',
  {
    reasons: ['reason'],
    skip_sending_email: true,
  },
  {
    headers: {
      Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
    },
  },
);
﻿
﻿
Updated 03 Dec 2024
Did this page help you?
Screening API
API reference