FastAppend

 API Docs
Back to App

FastAppend API Documentation

Welcome to the FastAppend API. This RESTful API allows you to programmatically enrich your contact data with our comprehensive data enrichment services.

Base URL

https://app.fastappend.com/v1/api/

Available Services

Business Trace

Enrich business names with complete contact information including addresses, phone numbers, and emails.

Email Append

Reverse lookup email addresses to find associated contact information and additional email addresses.

Phone Append

Reverse lookup phone numbers to discover owner information and related contact details.

Name Append

Search for individuals by name and location to find their contact information.

Authentication

All API requests require authentication using a Bearer token in the Authorization header.

Authorization: Bearer <YOUR_API_KEY>

You can generate your API token by calling the authentication endpoint with your FastAppend credentials, or retrieve it from your account dashboard.

Get API Token

POST

The FastAppend team needs to enable your account for API access, once done you will have access to your key in your profile settings. The same token can be used for all API endpoints.

POST /accounts/api/get-token/

Headers

Content-Type
application/json

Parameters

Name
Location
Type
Required
Description
email
body
string
Yes
Your FastAppend account email
password
body
string
Yes
Your FastAppend account password

Example Request

curl -X POST 'https://app.fastappend.com/accounts/api/get-token/' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "[email protected]",
    "password": "your-password"
  }'

Response (200)

{
  "api_key": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "message": "API key retrieved successfully"
}

Create Business Trace Job

POST

Upload a CSV file with business names and states to enrich with complete contact information. Returns business addresses, contact persons, phone numbers (mobile & landline), and email addresses.

POST /v1/api/business-trace/

Headers

Authorization
Bearer <YOUR_API_KEY>
Content-Type
multipart/form-data

Parameters

Name
Location
Type
Required
Description
csv_file
form-data
file
Yes
CSV file containing business names and states
business_name_column
form-data
string
Yes
Name of the column containing business names
state_column
form-data
string
Yes
Name of the column containing state abbreviations (e.g., TX, CA)

Example Request

curl -X POST 'https://app.fastappend.com/v1/api/business-trace/' \
  -H 'Authorization: Bearer <YOUR_API_KEY>' \
  -F 'csv_file=@/path/to/businesses.csv' \
  -F 'business_name_column=business_name' \
  -F 'state_column=state'

Response (201)

{
  "queue_id": 123,
  "status": "pending",
  "service_type": "business trace",
  "created_at": "2025-01-04T10:30:00Z",
  "message": "Business trace job created successfully"
}

Get Business Trace Job Status

GET

Retrieve the processing status and download URL for a business trace job. The download URL is available once processing is complete.

GET /v1/api/business-trace/<queue_id>/

Headers

Authorization
Bearer <YOUR_API_KEY>

Parameters

Name
Location
Type
Required
Description
queue_id
path
integer
Yes
The queue ID returned when creating the job

Example Request

curl -X GET 'https://app.fastappend.com/v1/api/business-trace/123/' \
  -H 'Authorization: Bearer <YOUR_API_KEY>'

Response (200)

{
  "id": 123,
  "created_at": "2025-01-04T10:30:00Z",
  "pending": false,
  "service_type": "business trace",
  "download_url": "https://fastappend.nyc3.cdn.digitaloceanspaces.com/fastappend/processed_file.csv",
  "rows_uploaded": 500,
  "credits_deducted": 450
}

Create Email Append Job

POST

Upload a CSV file with email addresses to perform reverse lookup and append additional contact information. Returns associated names, phone numbers, addresses, and related emails.

POST /v1/api/email-append/

Headers

Authorization
Bearer <YOUR_API_KEY>
Content-Type
multipart/form-data

Parameters

Name
Location
Type
Required
Description
csv_file
form-data
file
Yes
CSV file containing email addresses
email_column
form-data
string
Yes
Name of the column containing email addresses

Example Request

curl -X POST 'https://app.fastappend.com/v1/api/email-append/' \
  -H 'Authorization: Bearer <YOUR_API_KEY>' \
  -F 'csv_file=@/path/to/emails.csv' \
  -F 'email_column=email'

Response (201)

{
  "queue_id": 456,
  "status": "pending",
  "service_type": "email append",
  "created_at": "2025-01-04T11:00:00Z",
  "message": "Email append job created successfully"
}

Get Email Append Job Status

GET

Retrieve the processing status and download URL for an email append job.

GET /v1/api/email-append/<queue_id>/

Headers

Authorization
Bearer <YOUR_API_KEY>

Parameters

Name
Location
Type
Required
Description
queue_id
path
integer
Yes
The queue ID returned when creating the job

Example Request

curl -X GET 'https://app.fastappend.com/v1/api/email-append/456/' \
  -H 'Authorization: Bearer <YOUR_API_KEY>'

Response (200)

{
  "id": 456,
  "created_at": "2025-01-04T11:00:00Z",
  "pending": false,
  "service_type": "email append",
  "download_url": "https://fastappend.nyc3.cdn.digitaloceanspaces.com/fastappend/processed_emails.csv",
  "rows_uploaded": 1000,
  "credits_deducted": 850
}

Create Phone Append Job

POST

Upload a CSV file with phone numbers to perform reverse lookup and append contact information. Returns associated names, addresses, emails, and additional phone numbers.

POST /v1/api/phone-append/

Headers

Authorization
Bearer <YOUR_API_KEY>
Content-Type
multipart/form-data

Parameters

Name
Location
Type
Required
Description
csv_file
form-data
file
Yes
CSV file containing phone numbers
phone_column
form-data
string
Yes
Name of the column containing phone numbers

Example Request

curl -X POST 'https://app.fastappend.com/v1/api/phone-append/' \
  -H 'Authorization: Bearer <YOUR_API_KEY>' \
  -F 'csv_file=@/path/to/phones.csv' \
  -F 'phone_column=phone'

Response (201)

{
  "queue_id": 789,
  "status": "pending",
  "service_type": "phone append",
  "created_at": "2025-01-04T12:00:00Z",
  "message": "Phone append job created successfully"
}

Get Phone Append Job Status

GET

Retrieve the processing status and download URL for a phone append job.

GET /v1/api/phone-append/<queue_id>/

Headers

Authorization
Bearer <YOUR_API_KEY>

Parameters

Name
Location
Type
Required
Description
queue_id
path
integer
Yes
The queue ID returned when creating the job

Example Request

curl -X GET 'https://app.fastappend.com/v1/api/phone-append/789/' \
  -H 'Authorization: Bearer <YOUR_API_KEY>'

Response (200)

{
  "id": 789,
  "created_at": "2025-01-04T12:00:00Z",
  "pending": false,
  "service_type": "phone append",
  "download_url": "https://fastappend.nyc3.cdn.digitaloceanspaces.com/fastappend/processed_phones.csv",
  "rows_uploaded": 750,
  "credits_deducted": 680
}

Create Name Append Job

POST

Upload a CSV file with names (and optionally location) to find and append contact information. Returns addresses, phone numbers, and email addresses associated with the person.

POST /v1/api/name-append/

Headers

Authorization
Bearer <YOUR_API_KEY>
Content-Type
multipart/form-data

Parameters

Name
Location
Type
Required
Description
csv_file
form-data
file
Yes
CSV file containing names
first_name_column
form-data
string
Yes
Name of the column containing first names
last_name_column
form-data
string
Yes
Name of the column containing last names
middle_name_column
form-data
string
No
Name of the column containing middle names (optional, improves accuracy)
mail_city_column
form-data
string
No
Name of the column containing city (optional, improves accuracy)
mail_state_column
form-data
string
No
Name of the column containing state (optional, improves accuracy)

Example Request

curl -X POST 'https://app.fastappend.com/v1/api/name-append/' \
  -H 'Authorization: Bearer <YOUR_API_KEY>' \
  -F 'csv_file=@/path/to/names.csv' \
  -F 'first_name_column=first_name' \
  -F 'last_name_column=last_name' \
  -F 'mail_city_column=city' \
  -F 'mail_state_column=state'

Response (201)

{
  "queue_id": 101,
  "status": "pending",
  "service_type": "name append",
  "created_at": "2025-01-04T13:00:00Z",
  "message": "Name append job created successfully"
}

Get Name Append Job Status

GET

Retrieve the processing status and download URL for a name append job.

GET /v1/api/name-append/<queue_id>/

Headers

Authorization
Bearer <YOUR_API_KEY>

Parameters

Name
Location
Type
Required
Description
queue_id
path
integer
Yes
The queue ID returned when creating the job

Example Request

curl -X GET 'https://app.fastappend.com/v1/api/name-append/101/' \
  -H 'Authorization: Bearer <YOUR_API_KEY>'

Response (200)

{
  "id": 101,
  "created_at": "2025-01-04T13:00:00Z",
  "pending": false,
  "service_type": "name append",
  "download_url": "https://fastappend.nyc3.cdn.digitaloceanspaces.com/fastappend/processed_names.csv",
  "rows_uploaded": 300,
  "credits_deducted": 270
}

Webhooks

POST

FastAppend can automatically notify your application when a job completes by sending a POST request to your configured webhook URL. Configure your webhook URL in your account profile settings.

How It Works

When a queue processing job completes, FastAppend will send a POST request to the webhook URL configured in your account. No webhook registration endpoint is required - simply add your webhook URL in your profile settings.

Configuration: Set your webhook URL in your account profile settings.

Trigger: Webhooks are sent automatically when any job (Business Trace, Email Append, Phone Append, or Name Append) completes processing.

POST <YOUR_WEBHOOK_URL>

Webhook Payload

Field
Type
Description
id
integer
The queue/job ID
created_at
string
ISO 8601 timestamp when the job was created
pending
boolean
Processing status (false when complete)
type
string
Service type: "business trace", "email append", "phone append", or "name append"
download_url
string
URL to download the processed CSV file

Example Webhook Payload

# FastAppend will POST to your webhook URL automatically
# Example of what you'll receive:
POST https://your-domain.com/webhook
Content-Type: application/json

{
  "id": 123,
  "created_at": "2025-01-04T10:30:00Z",
  "pending": false,
  "type": "business trace",
  "download_url": "https://fastappend.nyc3.cdn.digitaloceanspaces.com/fastappend/processed_file.csv"
}

Payload Data

{
  "id": 123,
  "created_at": "2025-01-04T10:30:00Z",
  "pending": false,
  "type": "business trace",
  "download_url": "https://fastappend.nyc3.cdn.digitaloceanspaces.com/fastappend/processed_file.csv"
}

Important Notes

Your webhook endpoint should return a 2xx status code to acknowledge receipt. FastAppend will timeout after 5 seconds if no response is received.

FastAppend expects your webhook endpoint to be publicly accessible and respond within 5 seconds.

For security, consider validating webhook requests by checking the queue ID against your records or implementing webhook signatures.