Orba One
Search…
Orba One
Introduction
Guides
Quick Start - Web Integration
Integration
JavaScript
Android
iOS
React Native
REST API
Endpoints
Privacy Policy
FAQs
Glossary of Terms
Powered By GitBook
Endpoints
This document describes all the available endpoints for the Orba One API.

Clients

Extend and build your own custom platform using Orba One's available endpoints. We currently offer a Node.js REST API client, available on npm.
All API endpoints require the field AuthKey is present in the request header of each request. AuthKey is a combination of your ApiKey and Secret separated by a ':' and encoded in using base64 encoding.
Creating your AuthKey key header is simple and intuitive, simple and easy.
  1. 1.
    Get your ApiKey and Secret from within your dashboard.
  2. 2.
    Concatenate both values separated by a colon :
  3. 3.
    Encode the resulting concatenation in base64.
  4. 4.
    Append the AuthKey field in your header request and send the encoded value.
You can access your ApiKey and Secret from within your dashboard.
post
https://api.orbaone.com
/api/v1/applicants/create
Create Applicant
get
https://api.orbaone.com
/api/v1/applicants
Get Applicants
get
https://api.orbaone.com
/api/v1/applicants/<applicantId>
Get an Applicant
post
https://api.orbaone.com
/api/v1/applicants/<applicantId>/reset
Reset an Applicant
get
https://api.orbaone.com
/api/v1/applicants/<applicantId>/pep
Applicant PEP Scan
get
https://api.orbaone.com
/api/v1/applicants/<applicantId>/sanction
Applicant Sanction Scan
post
https://api.orbaone.com
/api/v1/scans/ocr
Create OCR Scan for document
get
https://api.orbaone.com
/api/v1/scans/ocr
Get OCR Scanned documents
get
https://api.orbaone.com
/api/v1/scans/ocr/<id>
Get an OCR Scanned document
post
https://api.orbaone.com
/api/v1/scans/facematch
Create face comparison
get
https://api.orbaone.com
/api/v1/scans/facematch
Get face comparisons
get
https://api.orbaone.com
/api/v1/scans/facematch/<id>
Get a face comparison
Integration - Previous
React Native
Next
Privacy Policy
Last modified 9mo ago
Copy link
On this page
Clients
post
Create Applicant
get
Get Applicants
get
Get an Applicant
post
Reset an Applicant
get
Create Applicant Verification Link
get
Applicant PEP Scan
get
Applicant Sanction Scan
post
Create OCR Scan for document
get
Get OCR Scanned documents
get
Get an OCR Scanned document
post
Create face comparison
get
Get face comparisons
get
Get a face comparison