Verosynthea
Sign in

Docs

Scoring API: getting started

title: "Getting Started with Profile Scoring"

Getting Started with Profile Scoring

The Profile Scoring API assigns one of eight demographic profiles to each row of customer data you upload. You send a CSV, we return the same CSV with three new columns: profile_id, profile_name, and profile_confidence. The whole process takes seconds.

This page walks you from zero to a scored file in about five minutes.

Step 1: Sign up and buy a credit bundle

If you do not already have an AUSynth account, create one at ausynth.com/signup. Free accounts include 5 credits per week, enough to score up to 500 rows.

If you need more, purchase a credit bundle from Account > Billing. Scoring costs 1 credit per 100 rows (rounded up), so a 100-credit bundle covers 10,000 rows.

Step 2: Generate an API key

Go to Account > API Keys and click Create key. Copy the key immediately. It starts with ask_live_ and will not be shown again.

Keep this key private. Do not commit it to version control, share it in emails, or pass it as a URL parameter. See Authentication for details.

Step 3: Prepare your CSV

Your CSV needs an id column (your own identifier for each row) and the nine profiling variables. Here is a minimal example:

id,AGE_GROUP,SEX,MARITAL_STATUS,HOUSEHOLD_ROLE,INCOME,EDUCATION,OCCUPATION,INDUSTRY,LABOUR_FORCE
CUST_1000,Early career,Male,Partnered,Family head,Mid,Bachelor or higher,Managers and professionals,Knowledge services,Full-time employed
CUST_1001,Senior,Female,Single,Non-family,Low,Year 11 or below,Not in employment,Other / Not employed,Not in labour force

See Data Format for the full list of accepted values and column name options.

Step 4: Score it

Send the file with a single curl command:

curl -X POST https://api.ausynth.com/api/score \
  -H "Authorization: Bearer ask_live_abc123def456" \
  -F "file=@my_customers.csv"

Replace ask_live_abc123def456 with your actual key and my_customers.csv with your file path.

Step 5: Get your results

For files with 10,000 rows or fewer, the response is immediate:

{
  "status": "complete",
  "credits_charged": 1,
  "rows_scored": 50,
  "download_url": "https://...",
  "download_expires_at": "2026-05-26T10:30:00Z"
}

Download the scored CSV from download_url. It contains your original data plus profile_id, profile_name, and profile_confidence. The download link is valid for 24 hours.

For larger files (over 10,000 rows), the API returns a job_id and a poll_url. Poll that URL until status changes to "complete", then download the results the same way. Most files under 100,000 rows complete within 10 seconds.

What happens to my data?

Your upload is processed and deleted within 24 hours. AUSynth does not store customer data permanently and does not use it to retrain the profiling model. See FAQ for more details.

Next steps