Contact previews do not expose private contact channels. Use POST /contacts/reveal to reveal full contact data for selected preview IDs.
Reveals use the same shared monthly contact credits as the StoreInspect web app.
Reveal flow
- Search contacts with
POST /contacts/search.
- Select contact IDs from preview results.
- Check remaining credits with
GET /usage.
- Reveal selected contacts with
POST /contacts/reveal.
Idempotency
Reveal requests support an optional Idempotency-Key header.
Use the same idempotency key when retrying the exact same reveal request after a network failure.
curl https://storeinspect.com/api/v1/contacts/reveal \
-H "Authorization: Bearer $STOREINSPECT_API_KEY" \
-H "Idempotency-Key: reveal_batch_001" \
-H "Content-Type: application/json" \
-d '{"contact_ids":["ct_Example_AbCdEfGhIjKlMnOp"]}'
Revealed emails, phones, and profile URLs are sensitive. Keep them out of client logs and public analytics tools.