Track a signup
POST
Call this when someone creates an account. If the visitor arrived through a share link, pass the referral code so the signup is attributed to the right referrer.
apiKeyheader
AuthorizationBearer <token>Use a secret key such as sk_test_... in test mode or sk_live_... in production.
Idempotency-Key?stringA unique key that makes retries safe. Keys expire after 24 hours.
Format
uuidapplication/json- body
external_id*stringemail*stringFormat
emailreferral_code?stringThe code from the share link, usually read by the browser script.
ip_address?stringUsed by fraud checks. Never shown to the referrer.
The signup was accepted for processing.
application/json- response
id*stringreferrer_id*stringreferred_external_id?stringstatus*ReferralStatusValue in
"pending""in_review""converted""rejected""expired"risk_score?numberHigher scores are more likely to be abuse. Scores above your threshold are held for review.
Range
0 <= value <= 1created_at*stringFormat
date-timeconverted_at?|Format
date-timecurl -X POST 'https://api.referralapi.example/v1/events/signup' \ -H 'Content-Type: application/json' \ -d '{ "external_id": "user_2088", "email": "sam@example.com"}'Example Response202
{ "id": "rfl_7Yp1aZc6", "referrer_id": "string", "referred_external_id": "string", "status": "pending", "risk_score": 0, "created_at": "2019-08-24T14:15:22Z", "converted_at": "2019-08-24T14:15:22Z"}