API Reference

get
Responses
chevron-right
200Success

No content

get
/persona/list
200Success

No content

get
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

get
/persona/{id}
200Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/persona/{id}
200Success

No content

delete
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

delete
/persona/{id}
200Success

No content

post
Body
objectOptional
Responses
post
/persona/create
201Success

No content

delete
Responses
chevron-right
200Success

No content

delete
/persona/active
200Success

No content

put
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

put
/persona/{id}/set-active
200Success

No content

post
Responses
post
/persona/upload/avatar
201Success

No content

put
Path parameters
idstringRequired
accountIdstringRequired
Responses
chevron-right
200Success

No content

put
/persona/{id}/wallet/{accountId}/add
200Success

No content

get
Path parameters
userIdstringRequired
Responses
chevron-right
200Success

No content

get
/profiles/{userId}
200Success

No content

get
Path parameters
userIdstringRequired
personaIdstringRequired
Responses
chevron-right
200Success

No content

get
/profiles/{userId}/{personaId}
200Success

No content

get
Query parameters
pagestringRequired
limitstringRequired
userIdstringRequired
emailstringRequired
actionstringRequired
startDatestringRequired
endDatestringRequired
Responses
chevron-right
200Success

No content

get
/activity-logs
200Success

No content

get
Query parameters
startDatestringRequired
endDatestringRequired
Responses
chevron-right
200Success

No content

get
/activity-logs/statistics
200Success

No content

post
Responses
chevron-right
200Success

No content

post
/activity-logs/reset-rate-limit
200Success

No content

get
Responses
chevron-right
200Success

No content

get
/kyc/status
200Success

No content

post
Body
objectOptional
Responses
post
/kyc/bronze
201Success

No content

post
Body
objectOptional
Responses
post
/kyc/silver
201Success

No content

post
Body
objectOptional
Responses
post
/kyc/gold
201Success

No content

post
Responses
post
/kyc/upload/selfie
201Success

No content

post
Responses
post
/kyc/upload/proof
201Success

No content

post
Body
objectOptional
Responses
post
/payment-links
201Success

No content

Path parameters
personaIdstringRequired
Responses
chevron-right
200Success

No content

get
/payment-links/persona/{personaId}
200Success

No content

Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

get
/payment-links/{id}
200Success

No content

Path parameters
shortIdstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/payment-links/{shortId}
200Success

No content

Path parameters
shortIdstringRequired
Responses
chevron-right
200Success

No content

delete
/payment-links/{shortId}
200Success

No content

post
Body
objectOptional
Responses
post
/flow-log/track
201Success

No content

post
Path parameters
certificateIdstringRequired
Responses
post
/flow-log/enter/{certificateId}
201Success

No content

post
Path parameters
certificateIdstringRequired
Responses
post
/flow-log/view-passport/{certificateId}
201Success

No content

post
Path parameters
certificateIdstringRequired
Responses
post
/flow-log/exit/{certificateId}
201Success

No content

post
Path parameters
certificateIdstringRequired
Responses
post
/flow-log/add-to-apple-wallet/{certificateId}
201Success

No content

post
Path parameters
certificateIdstringRequired
Responses
post
/flow-log/add-to-google-wallet/{certificateId}
201Success

No content

get
Path parameters
userIdstringRequired
Query parameters
limitnumberRequired
Responses
chevron-right
200Success

No content

get
/flow-log/user/{userId}
200Success

No content

get
Path parameters
certificateIdstringRequired
Query parameters
limitnumberRequired
Responses
chevron-right
200Success

No content

get
/flow-log/certificate/{certificateId}
200Success

No content

get
Query parameters
limitnumberRequired
Responses
chevron-right
200Success

No content

get
/flow-log/all
200Success

No content

post
Responses
post
/flow-log/expire-inactive
201Success

No content

put
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/flow-log/settings
200Success

No content

delete
Body
objectOptional
Responses
chevron-right
200Success

No content

delete
/flow-log/batch
200Success

No content

post
Body
objectOptional
Responses
post
/flow-log/count
201Success

No content

get
Responses
chevron-right
200Success

No content

get
/flow-log/stats
200Success

No content

post
Responses
post
/facial-recognition/upload
201Success

No content

put
Path parameters
recordIdstringRequired
Responses
chevron-right
200Success

No content

put
/facial-recognition/{recordId}/result
200Success

No content

get
Path parameters
userIdstringRequired
Responses
chevron-right
200Success

No content

get
/facial-recognition/user/{userId}/latest
200Success

No content

get
Path parameters
userIdstringRequired
Query parameters
limitstringRequired
Responses
chevron-right
200Success

No content

get
/facial-recognition/user/{userId}/history
200Success

No content

get
Query parameters
limitstringRequired
skipstringRequired
Responses
chevron-right
200Success

No content

get
/facial-recognition/successful-logins
200Success

No content

get
Responses
chevron-right
200Success

No content

get
/vetpass/categories
200Success

No content

get
Path parameters
categoryIdstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/ai-config/{categoryId}
200Success

No content

get
Path parameters
brandIdstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/clinic/{brandId}
200Success

No content

get
Path parameters
brandIdstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/shop-items/{brandId}
200Success

No content

get
Query parameters
certificate_idstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/animals
200Success

No content

post
Body
objectOptional
Responses
post
/vetpass/animals
201Success

No content

get
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/animals/{id}
200Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/vetpass/animals/{id}
200Success

No content

delete
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

delete
/vetpass/animals/{id}
200Success

No content

get
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/animals/{id}/summary
200Success

No content

get
Responses
chevron-right
200Success

No content

get
/vetpass/events
200Success

No content

post
Body
objectOptional
Responses
post
/vetpass/events
201Success

No content

post
Body
objectOptional
Responses
post
/vetpass/events/batch
201Success

No content

get
Query parameters
animal_idstringRequired
limitnumberRequired
Responses
chevron-right
200Success

No content

get
/vetpass/events/upcoming
200Success

No content

get
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/events/{id}
200Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/vetpass/events/{id}
200Success

No content

delete
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

delete
/vetpass/events/{id}
200Success

No content

get
Query parameters
animal_idstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/reminders
200Success

No content

post
Body
objectOptional
Responses
post
/vetpass/reminders
201Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/vetpass/reminders/{id}
200Success

No content

delete
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

delete
/vetpass/reminders/{id}
200Success

No content

get
Responses
chevron-right
200Success

No content

get
/vetpass/measurements
200Success

No content

post
Body
objectOptional
Responses
post
/vetpass/measurements
201Success

No content

get
Responses
chevron-right
200Success

No content

get
/vetpass/measurement-types
200Success

No content

get
Path parameters
animalIdstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/animals/{animalId}/measurement-assignments
200Success

No content

get
Path parameters
animalIdstringRequired
Query parameters
measurement_type_idstringRequired
limitstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/animals/{animalId}/measurement-entries
200Success

No content

get
Responses
chevron-right
200Success

No content

get
/vetpass/medication-doses
200Success

No content

post
Body
objectOptional
Responses
post
/vetpass/medication-doses
201Success

No content

post
Body
objectOptional
Responses
post
/vetpass/medication-doses/batch
201Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/vetpass/medication-doses/{id}
200Success

No content

get
Responses
chevron-right
200Success

No content

get
/vetpass/vaccinations
200Success

No content

post
Body
objectOptional
Responses
post
/vetpass/vaccinations
201Success

No content

post
Body
objectOptional
Responses
post
/vetpass/vaccinations/schedule
201Success

No content

get
Query parameters
animal_idstringRequired
days_aheadnumberRequired
Responses
chevron-right
200Success

No content

get
/vetpass/vaccinations/due
200Success

No content

get
Query parameters
animal_idstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/vaccinations/summary
200Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/vetpass/vaccinations/{id}/administer
200Success

No content

get
Query parameters
animal_idstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/care-plans
200Success

No content

post
Body
objectOptional
Responses
post
/vetpass/care-plans
201Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/vetpass/care-plans/{id}
200Success

No content

delete
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

delete
/vetpass/care-plans/{id}
200Success

No content

get
Query parameters
care_plan_idstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/care-plan-tasks
200Success

No content

post
Body
objectOptional
Responses
post
/vetpass/care-plan-tasks
201Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/vetpass/care-plan-tasks/{id}
200Success

No content

get
Query parameters
animal_idstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/files
200Success

No content

post
Body
objectOptional
Responses
post
/vetpass/files
201Success

No content

delete
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

delete
/vetpass/files/{id}
200Success

No content

get
Query parameters
unread_onlybooleanRequired
Responses
chevron-right
200Success

No content

get
/vetpass/notifications
200Success

No content

put
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

put
/vetpass/notifications/{id}/read
200Success

No content

put
Responses
chevron-right
200Success

No content

put
/vetpass/notifications/read-all
200Success

No content

get
Path parameters
animalIdstringRequired
Responses
chevron-right
200Success

No content

get
/vetpass/animals/{animalId}/clinics
200Success

No content

post
Path parameters
animalIdstringRequired
Body
objectOptional
Responses
post
/vetpass/animals/{animalId}/clinics
201Success

No content

put
Path parameters
animalIdstringRequired
clinicLinkIdstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/vetpass/animals/{animalId}/clinics/{clinicLinkId}
200Success

No content

delete
Path parameters
animalIdstringRequired
clinicLinkIdstringRequired
Responses
chevron-right
200Success

No content

delete
/vetpass/animals/{animalId}/clinics/{clinicLinkId}
200Success

No content

post
Path parameters
animalIdstringRequired
Body
objectOptional
Responses
post
/vetpass/animals/{animalId}/clinics/match
201Success

No content

get
Query parameters
certificate_idstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/profiles
200Success

No content

post
Body
objectOptional
Responses
post
/medipass/profiles
201Success

No content

get
Path parameters
certificateIdstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/profiles/by-certificate/{certificateId}
200Success

No content

get
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/profiles/{id}
200Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/medipass/profiles/{id}
200Success

No content

delete
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

delete
/medipass/profiles/{id}
200Success

No content

get
Query parameters
profile_idstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/files
200Success

No content

post
Body
objectOptional
Responses
post
/medipass/files
201Success

No content

delete
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

delete
/medipass/files/{id}
200Success

No content

get
Query parameters
profile_idstringRequired
statusstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/prescriptions
200Success

No content

post
Body
objectOptional
Responses
post
/medipass/prescriptions
201Success

No content

get
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/prescriptions/{id}
200Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/medipass/prescriptions/{id}
200Success

No content

delete
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

delete
/medipass/prescriptions/{id}
200Success

No content

get
Query parameters
profile_idstringRequired
prescription_idstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/medications
200Success

No content

get
Responses
chevron-right
200Success

No content

get
/medipass/medications/active
200Success

No content

get
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/medications/{id}
200Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/medipass/medications/{id}
200Success

No content

delete
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

delete
/medipass/medications/{id}
200Success

No content

get
Responses
chevron-right
200Success

No content

get
/medipass/medication-doses
200Success

No content

post
Body
objectOptional
Responses
post
/medipass/medication-doses
201Success

No content

post
Body
objectOptional
Responses
post
/medipass/medication-doses/batch
201Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/medipass/medication-doses/{id}
200Success

No content

get
Query parameters
profile_idstringRequired
datestringRequired
Responses
chevron-right
200Success

No content

get
/medipass/daily-summary
200Success

No content

get
Query parameters
profile_idstringRequired
start_datestringRequired
end_datestringRequired
Responses
chevron-right
200Success

No content

get
/medipass/dose-history
200Success

No content

get
Responses
chevron-right
200Success

No content

get
/medipass/doctors
200Success

No content

post
Body
objectOptional
Responses
post
/medipass/doctors
201Success

No content

get
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/doctors/{id}
200Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/medipass/doctors/{id}
200Success

No content

delete
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

delete
/medipass/doctors/{id}
200Success

No content

get
Query parameters
profile_idstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/profile-doctors
200Success

No content

post
Body
objectOptional
Responses
post
/medipass/profile-doctors
201Success

No content

delete
Query parameters
profile_idstringRequired
doctor_idstringRequired
Responses
chevron-right
200Success

No content

delete
/medipass/profile-doctors
200Success

No content

get
Query parameters
profile_idstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/profile-doctors/favorite
200Success

No content

post
Body
objectOptional
Responses
post
/medipass/profile-doctors/set-favorite
201Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/medipass/profile-doctors/{id}
200Success

No content

get
Query parameters
profile_idstringRequired
statusstringRequired
typestringRequired
from_datestringRequired
to_datestringRequired
limitstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/appointments
200Success

No content

post
Body
objectOptional
Responses
post
/medipass/appointments
201Success

No content

get
Query parameters
profile_idstringRequired
limitstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/appointments/upcoming
200Success

No content

get
Query parameters
profile_idstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/appointments/next
200Success

No content

get
Query parameters
profile_idstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/appointments/today
200Success

No content

get
Query parameters
profile_idstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/appointments/stats
200Success

No content

get
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

get
/medipass/appointments/{id}
200Success

No content

put
Path parameters
idstringRequired
Body
objectOptional
Responses
chevron-right
200Success

No content

put
/medipass/appointments/{id}
200Success

No content

delete
Path parameters
idstringRequired
Responses
chevron-right
200Success

No content

delete
/medipass/appointments/{id}
200Success

No content

Last updated