Welile ID API

Base URL https://welileid.com/api/v1 · Machine-readable spec at /api/v1/openapi.json

Sign-in flow

Use the native Google Sign-In or Sign in with Apple SDK to get an ID token.
POST it to /auth/google or /auth/apple. You get access_token, refresh_token and has_profile.
Store tokens in Keychain / Android Keystore. Send Authorization: Bearer <access_token> on every call.
If has_profile is false, upload photos via /uploads then POST /profile.
On a 401, call /auth/refresh and retry once.

Errors always look like { "error": { "code", "message" } }.

POST/auth/googlePublic
Exchange a native Google Sign-In ID token for a Welile session.
Body
id_token — string, required — from Google Sign-In SDK
nonce — string, optional — raw nonce if you hashed one into the request
access_token — string, optional
POST/auth/applePublic
Exchange a native Sign in with Apple identity token for a Welile session.
Body
id_token — string, required — identityToken from ASAuthorization
nonce — string, recommended — the raw (unhashed) nonce
POST/auth/refreshPublic
Get a new access token before the old one expires (~1 hour).
Body
refresh_token — string, required
POST/auth/sign-outSigned in
End this device's session.

GET/meSigned in
Signed-in user, roles and whether they have created their Welile ID.
DELETE/meSigned in
Permanently delete the account, household and photos.
Body
confirmation — "DELETE"

POST/uploadsSigned in
Get a one-time upload URL for a photo. PUT the compressed JPEG to it, then save `path` on the profile.
Body
kind — id_photo | selfie | household_logo

GET/membersSigned in
List everyone under your ID, with search and filters.
Query
q — name or phone digits
filter — all | has_id | no_id | no_smartphone
type — dependent | provider
POST/membersSigned in
Add a family member directly (no invite).
Body
full_name — string, required
phone — string, required
parent_id — member id they sit under, optional
is_provider — boolean — true = 'I depend on them'
has_smartphone — boolean
birth_date — YYYY-MM-DD
id_expiry — YYYY-MM-DD
GET/members/:idSigned in
One member.
PATCH/members/:idSigned in
Edit a member.
Body
full_name — string
phone — string
parent_id — string | null
is_provider — boolean
has_smartphone — boolean | null
birth_date — YYYY-MM-DD | null
id_expiry — YYYY-MM-DD | null
DELETE/members/:idSigned in
Remove a member.
GET/members/linked-photosSigned in
Selfies and ID status of members who joined with their own login, keyed by member id.
GET/familySigned in
Nested family tree plus dashboard stats (totals, expiring IDs).
GET/membershipsSigned in
Households you have joined through an invite.

GET/whatsapp/contactsSigned in
Household contacts with wa.me links and the saved group link. Add ?format=vcf for a contacts file.
Query
format — json | vcf

GET/admin/adsAd manager
All adverts.
POST/admin/ads/uploadsAd manager
One-time upload URL for an advert image.
POST/admin/adsAd manager
Create an advert.
Body
title — string, required
image_path — from /admin/ads/uploads
link_url — string
is_active — boolean
PATCH/admin/ads/:idAd manager
Edit or switch an advert on/off.
Body
title — string
link_url — string | null
is_active — boolean
DELETE/admin/ads/:idAd manager
Delete an advert and its image.
GET/admin/staffAdmin
Everyone holding a staff role.
POST/admin/staffAdmin
Make an existing account an ad manager.
Body
email — string, required
DELETE/admin/staff/:userIdAdmin
Remove the ad manager role.

Not a replacement National ID.