Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
API Reference
/users/roles
Search
JUMP TO
Welcome to VerifyID
Introduction
Getting Started with VerifyID
Services
Virtual NIN
Verify ID API
Scheme Enrollment
Read one enrollment using the enrollment id and scheme id
get
Perform liveness check on an image
post
verification-controller
/verification-request/create
post
/verification-request/passed/verification-status/count
get
/verification-request/list
get
/verification-request/history
get
/verification-request/get-request-details/{id}
get
/verification-request/get-pension-details/{id}
get
/verification-request/failed/verification-status/count
get
Update one enrollment in a scheme
put
Get the result of a liveness check
get
Liveliness
Enroll a person in a scheme
post
user-management-controller
/users/validate
get
/users/validate
post
/users/update-role
post
/users/update-password
post
/users/reset-password
post
/users/resend-email-confirmation
post
/users/remove-role
post
/users/register
post
/users/invalidate
post
/users/deactivate
post
/users/create
post
/users/create-bulk
post
/users/confirm-email
post
/users/add-role
post
/users/activate
post
/users/Upload-agent-batch
post
/users/{id}
get
/users/verified-person/{phoneNumber}
get
/users/unique-email
get
/users/search
get
/users/roles
get
/users/error/download
get
/users/details
get
Finalize one enrollment in a scheme
put
settings-controller
/settings/update
post
/settings/description
post
/settings
get
Settings search
get
Read one enrollment using the enrollment uid
get
scheme-controller
/scheme/create-scheme
post
/scheme/{id}
get
/scheme/summary
get
/scheme/search
get
portal-user-controller
/portal-users/change-user-password/{username}
post
/portal-users/unique-user-phone
get
/portal-users/unique-user-email
get
/portal-users/fetch/by-phone
get
/portal-users/fetch/by-email
get
one-time-password-controller
/otp/verify
post
/otp/request
post
user-controller
/me/address
post
/logout
post
/me
get
bw-file-controller
/files/upload
post
/files/plugin/upload
post
/files/{id}
get
/files/plugin/download/{fileName}
get
/files/bw-file/{id}
get
face-validation-controller
/face-validation/request
post
/face-validation/{messageId}/query
get
api-client-controller
/api-clients
get
/api-clients
post
/api-clients/{id}/update
post
/api-clients/{id}/regenerate-secret
post
/api-clients/{id}/deactivate
post
/api-clients/{id}/activate
post
/api-clients/scopes
get
util-controller
/utils/status
get
portal-account-controller
/portal-accounts
get
/portal-accounts/{accountCode}/roles
get
monitoring-controller
/monitor
get
location
search states
get
search LGAs
get
search countries
get
dashboard-controller
/dashboard
get
Powered by
/users/roles
get
http://verifyid.africa/api/users/roles
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!
