Corrily home pagelight logo
Users
Identify Call
POST

/v1/identify

X-Api-Key*
curl --request POST \
  --url https://client.corrily.com/v1/identify \
  --header 'X-Api-Key: <x-api-key>' \
  --data '{
  "user_id": "<user_id>"
}'

The identify endpoint serves three purposes:

  1. It can be used to pass user-level features after (or before) a price has already been tied to them using the main price endpoint.
  2. It can be used to link IPs to user_ids so that prices persist to a user as they see a price -> login in -> check the price again.
  3. It is used during mobile integrations to inform Corrily about original Apple and Google purchase IDs.

​
Body Params

user_idrequired
string

A User ID.

ip
string

An IP you wish to tie the user to. For more information read our anonymous users guide.

country
string

Optional field which indicates the country which the user belongs to. If the country given is not part of the experiment for the ip user, the user id given wont be added to the experiment via identify. Please note this country wont be stored against user. This is used only for validating if the experiment characteristics for previous user from the ip can be applied to the user id. The user country will be locked to the country given in subsequent price call.

features
object

An object containing arbitrary key-value pairs that represent characteristics of this user which may affect their optimal price. The keys can be any valid JSON key. The values can be strings, integers, or floats.

apple_original_transaction_id
object

Pass an original_transaction_id for a user when they purchase an IAP product. (Note that in the backend, this will not overwrite any previously stored transaction IDs for this user).

google_purchase_token
object

Pass an purchaseToken for a user when they purchase an in-app product. (Note that in the backend, this will not overwrite any previously stored purchase tokens for this user).

​
Response

status
string
variants_overwritten
string

Its an optional field. If the identify call copied experiment attributes from ip to the user, this attribute will be included in the response. Otherwise, it wont be included in the response.

curl --request POST \
     --url https://client.corrily.com/v1/identify \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '{ user_id: "string", features: {source: "youtube"} }'

{
  "status": "ok"
}