Scrub with Unique Identifiers
Full Scrub
Scrub with Unique Identifiers
Pass a unique identifier with each phone number
GET
Scrub with Unique Identifiers
Pass a unique identifier (such as Account ID, Record ID, or Member ID) with each phone number and have it returned in the response. This allows you to easily match scrub results back to your records.
The unique identifier will be returned in the
How It Works
Append a pipe character (|) followed by your unique identifier to each phone number:
Reserved field of the response.
Request
Headers
string
required
Your API Key
Query Parameters
string
required
Phone number with identifier in format:
PHONE|ID (e.g.,
5039367181|ACCT-12345). For multiple numbers, comma-separate them:
5039367181|ACCT-001,7075276405|ACCT-002string
default:"5"
required
API version. Use
5string
default:"csv"
Response format:
json or csvstring
Project ID
string
Campaign ID
Example Request
The
Reserved field contains your unique identifier "ACCT-12345".Response Fields
string
The phone number that was scrubbed
string
The scrub result code (see Result
Codes)
string
Your unique identifier passed with the phone number
string
Explanation of why the number is flagged
string
State/region abbreviation (e.g., “CA”)
string
Country code (e.g., “US”)
string
City or locality
string
Carrier information in format:
ID;TYPE;"Name"string
Timezone code
string
UTC offset in minutes
string
1 if wireless/VoIP, 0 otherwisestring
Line type:
Wireless, VoIP, or AllOtherMultiple Numbers with Identifiers
Comma-separate multiple phone numbers with their identifiers:Example
Use Cases
CRM Integration
Pass your CRM Record ID to update records directly after scrubbing
Batch Processing
Track which phone number belongs to which customer in large batches
Audit Trail
Include transaction IDs for compliance logging
Database Updates
Pass primary keys to enable efficient database updates
Best Practices
- Keep identifiers reasonably short
- Use URL-safe characters
- Consider encoding special characters if needed