Quickstart

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 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 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 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 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 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 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 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}`, }, }, );