Quickstart

3min

Authentication
To access Boom's CRA API, you will need an API key provided by Boom. You need to send the API key inside the Authentication header using the standard format Bearer YOUR_API_KEY. Here is a request example in Boom's Sandbox environment:
Curl
curl --request GET \
  --url https://cra.sandbox.boompay.app/partner/v1/reports \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json'
curl --request GET \
  --url https://cra.sandbox.boompay.app/partner/v1/reports \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json'
﻿
Testing
The CRA API can be tested in Sandbox using test cases. 
For each report, Boom has provided test case data (e.g., First name, Last name, SSN, etc.) that you need to send to the reports endpoint to get the desired report. Here is an example of a request to our reports endpoints and also the table with test cases you can send for specific reports.
Curl
curl --request POST \
  --url https://cra.sandbox.boompay.app/partner/v1/reports \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "Jonathan",
  "last_name": "Consumer",
  "ssn": "123456789",
  "address1": "123 Main St",
  "address2": "Apt 1",
  "city": "New York",
  "state": "NY",
  "dob": "1990-01-01T00:00:00.000Z",
  "zip": "12345",
  "reports": [
	"eviction_report",
    "criminal_report"
  ]
}'
curl --request POST \
  --url https://cra.sandbox.boompay.app/partner/v1/reports \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "Jonathan",
  "last_name": "Consumer",
  "ssn": "123456789",
  "address1": "123 Main St",
  "address2": "Apt 1",
  "city": "New York",
  "state": "NY",
  "dob": "1990-01-01T00:00:00.000Z",
  "zip": "12345",
  "reports": [
	"eviction_report",
    "criminal_report"
  ]
}'
﻿
Report
First name
Last name
SSN
City
State
eviction_report
Kris
Consumer
ANY VALID SSN
ANY CITY
ANY STATE
eviction_report
Indiana
Consumer
ANY VALID SSN
ANY CITY
ANY STATE
eviction_report
Jimmie
Consumer
ANY VALID SSN
ANY CITY
ANY STATE
eviction_report
Melinda
Consumer
ANY VALID SSN
ANY CITY
ANY STATE
eviction_report
Yvonne
Consumer
ANY VALID SSN
ANY CITY
ANY STATE
eviction_report
Erika
Consumer
ANY VALID SSN
ANY CITY
ANY STATE
criminal_report
Harold
Chuang
ANY VALID SSN
ANY CITY
ANY STATE
criminal_report, eviction_report
Jonathan
Consumer
ANY VALID SSN
ANY CITY
ANY STATE
criminal_report, eviction_report
Victor
Consumer
ANY VALID SSN
ANY CITY
ANY STATE
criminal_report, eviction_report
Stacy
Consumer
ANY VALID SSN
ANY CITY
ANY STATE
criminal_report, eviction_report
Frank
Consumer
ANY VALID SSN
ANY CITY
ANY STATE
criminal_report
Jorge
Akkaya
ANY VALID SSN
ANY CITY
ANY STATE
criminal_report
Jennifer
Ray
ANY VALID SSN
ANY CITY
ANY STATE
criminal_report
James
Bergman
ANY VALID SSN
ANY CITY
ANY STATE
credit_report
RST
TUMAYW
666008818
SAVANNAH
GA
credit_report
WLS
UVFHJJ
666009420
FRUITVALE
ID
credit_report
GLNS
VENOQYXL
666020749
ARDMORE
OK
credit_report
RDS
VY
666002857
MECCA
CA
credit_report
TR
VYR
666001497
SANFRANCISCO
CA
credit_report
WALL
WWPOJTD
666009665
MACON
IL
credit_report
FRK
XEMPYKIKZKG
666003100
SANFRANCISCO
CA
credit_report
CO
XFCHZBCT
666006625
JACKSONVILLE
FL
credit_report
PTS
XQKFMH
666005335
JACKSONVILLE
FL
credit_report
RPD
XXFHBDYOH
666002182
SANJOSE
CA
credit_report
VLGS
ZUOBMLL
666008799
LAKELAND
GA
﻿

Report	First name	Last name	SSN	City	State
eviction_report	Kris	Consumer	ANY VALID SSN	ANY CITY	ANY STATE
eviction_report	Indiana	Consumer	ANY VALID SSN	ANY CITY	ANY STATE
eviction_report	Jimmie	Consumer	ANY VALID SSN	ANY CITY	ANY STATE
eviction_report	Melinda	Consumer	ANY VALID SSN	ANY CITY	ANY STATE
eviction_report	Yvonne	Consumer	ANY VALID SSN	ANY CITY	ANY STATE
eviction_report	Erika	Consumer	ANY VALID SSN	ANY CITY	ANY STATE
criminal_report	Harold	Chuang	ANY VALID SSN	ANY CITY	ANY STATE
criminal_report, eviction_report	Jonathan	Consumer	ANY VALID SSN	ANY CITY	ANY STATE
criminal_report, eviction_report	Victor	Consumer	ANY VALID SSN	ANY CITY	ANY STATE
criminal_report, eviction_report	Stacy	Consumer	ANY VALID SSN	ANY CITY	ANY STATE
criminal_report, eviction_report	Frank	Consumer	ANY VALID SSN	ANY CITY	ANY STATE
criminal_report	Jorge	Akkaya	ANY VALID SSN	ANY CITY	ANY STATE
criminal_report	Jennifer	Ray	ANY VALID SSN	ANY CITY	ANY STATE
criminal_report	James	Bergman	ANY VALID SSN	ANY CITY	ANY STATE
credit_report	RST	TUMAYW	666008818	SAVANNAH	GA
credit_report	WLS	UVFHJJ	666009420	FRUITVALE	ID
credit_report	GLNS	VENOQYXL	666020749	ARDMORE	OK
credit_report	RDS	VY	666002857	MECCA	CA
credit_report	TR	VYR	666001497	SANFRANCISCO	CA
credit_report	WALL	WWPOJTD	666009665	MACON	IL
credit_report	FRK	XEMPYKIKZKG	666003100	SANFRANCISCO	CA
credit_report	CO	XFCHZBCT	666006625	JACKSONVILLE	FL
credit_report	PTS	XQKFMH	666005335	JACKSONVILLE	FL
credit_report	RPD	XXFHBDYOH	666002182	SANJOSE	CA
credit_report	VLGS	ZUOBMLL	666008799	LAKELAND	GA

Updated 05 Apr 2024

Did this page help you?

Consumer Reporting Agency API

API reference