Scrub + Add EBR
Full Scrub
Scrub + Add EBR
Scrub phone numbers and add or refresh their EBR records in a single API call
POST
Scrub + Add EBR
Scrub one or more phone numbers and add or refresh their Existing Business Relationship (EBR) records in a single request. This is the combined version of the Scrub and EBR and Consent endpoints: each number is checked against the DNC lists, and any EBR records you include in the same request are written before the result is returned, so the scrub result reflects the EBR you just submitted.
Use this when your system establishes (or re-establishes) a business relationship at the same moment it needs a compliance decision — for example, logging an inquiry and immediately deciding whether the number is callable.
Request
Headers
string
required
Your API Key
string
required
Must be
application/jsonRequest Body
string
required
Comma-separated list of 10-digit phone numbers (e.g.,
5039367187,7075276405). To include a system identifier with each result,
append |{id} to the phone number (e.g.,
5039367187|abc-10232,7075276405|abc-10233).string
default:"7"
required
API version. Use
7 (latest). Version 6 adds EBRExpiresOn — useful here
to see the expiration of the EBR you just submitted; version 7 also adds
WirelessPortDate and VoIPDate.string
default:"json"
Response format:
json or csvstring
Optional. Project ID
string
Optional. Campaign ID
integer
default:"0"
When set to
1, if an EBR record already exists for a number being submitted
and the existing EBR is “better” than the one being added, the existing EBR is
not overwritten. Federal EBR expiration dates determine which is better
(longer remaining validity = better). Defaults to 0, which overwrites the
existing EBR and resets its expiration window.array
Optional. EBR records to add or refresh as part of this scrub. Each record
applies to the
phoneNumber it names, which should also appear in
phoneList.Example Request
Response Fields
The response is identical to the standard Scrub response, one row per number inphoneList. Because the EBR is written before the scrub result is computed, the result reflects the EBR you submitted.
string
The scrub result code. Numbers with a valid EBR return an EBR-related code such
as
E, F, G, H, or O (see
Output Guide).string
The type of EBR currently on the record (e.g.,
I for Inquiry), or blank if
the record has no EBR.string
When the EBR expires, format
YYYY-MM-DD HH:MM:SS. The earlier of the
federal and state expiration dates — reflects the EBR you just submitted.
Empty if no EBR. Requires version=6 or higher. The time portion is always
23:59:00 (end of day) and no timezone is included — treat the value as a
date and compare against your local calendar date rather than parsing it as a
UTC timestampHow It Works
- Any records in
ebrListare added or refreshed, honoringkeepBetterEBR. - Every number in
phoneListis scrubbed against the DNC lists. - The scrub result — including any EBR exemption applied in step 1 — is returned.
phoneList without a matching ebrList entry (scrub only), and you can submit multiple EBR records in one request.
Best Practices
Submit EBRs Only on Real Contact Events
Submit EBRs Only on Real Contact Events
Submit an EBR when an actual business relationship event occurs (an inquiry,
sale, or grant of permission) — not on every scrub. Re-submitting an EBR for
the same number repeatedly resets its date of last contact and rolls the
expiration window forward, which can keep an exemption alive longer than the
relationship justifies.
Use keepBetterEBR to Avoid Downgrades
Use keepBetterEBR to Avoid Downgrades
Set
keepBetterEBR: 1 to preserve an existing EBR that has longer remaining
validity instead of overwriting it with a shorter one.Use Accurate Dates
Use Accurate Dates
The
dateOfLastContact should be the actual date of the business
relationship event, not the current date.Output Format
Output Format
Use
output=csv for large batches. CSV parsing is more efficient for
high-volume processing.