Getting Started

Introduction

This document provides the APIs that help you manage the initial configurations for setting up the Unifyia platform. The following are the features that you can leverage using the rest APIs detailed in this document.

Fetch Organization Data
Roles and Permission
Device Profiles
Groups
Visual Designs
Relying Party
Certificate Authority
Identity Verification Providers
Biometrics
Workflows
Credential Preference

The platform APIs are based on REST principles. The APIs use standard HTTP response codes and token-based authentication.

Conventions

Status - HTTP status code of the response.
All the possible status codes are listed under Responses for each API. Just to let you know, only one of them is issued as requested.
All responses are in JSON format.
A path/query parameter is sent as a part of the endpoint URL.
All request parameters are mandatory (Required) unless explicitly marked as (optional).
The type of values accepted for a request parameter is shown in the values column like this (10| <any number>). The | symbol means OR. If the parameter is (Optional) the default value is shown in blue bold text, as 10 written in (10| <any number>).

Terms	Description
IDP	Identity Provider
Redirect URI	Determines where the server redirects the user after the user completes a flow. The value must exactly match one of the authorized redirect URIs for the OAuth 2.0 client, which you configured in your client's API Console Credentials page. If this value doesn't match an authorized redirect URI for the provided client_id you will get a redirect_uri_mismatch error. Note that the http or https scheme, case, and trailing slash ('/') must all match. To set this value in PHP, call the setRedirectUri function. Note that you must specify a valid redirect URI for the provided client_id. $client->setRedirectUri('https://oauth2.example.com/code';
Unifyia Digital Identity Services	The platform that issues and manages the identities to the users.
URI	Uniform Resource Identifier (URI) encompasses all types of names and addresses that refer to objects on the web.
URL	Uniform Resource Locator
UTC	Date and time format in Coordinated Universal Time format - YYYY-MM-DDThh:mm:ss.sTZD E.g.: 1997-07-16T19:20:30.45+01:00) where: YYYY = four-digit year MM = two-digit month (01=January, etc.) DD = two-digit day of month (01 through 31) hh = two digits of hour (00 through 23) (am/pm NOT allowed) mm = two digits of minute (00 through 59) ss = two digits of second (00 through 59) s = one or more digits representing a decimal fraction of a second TZD = time zone designator (Z or +hh:mm or -hh:mm)
NONCE	In cryptography, nonce is an arbitrary number that can be used just once in a cryptographic communication. It is a number issued in an authentication protocol to ensure that old communications cannot be reused in replay attacks.

Status Codes

All status codes are standard HTTP status codes. The below ones are used in this API.

2XX - Success of some kind
4XX - Error occurred in the client's part
5XX - Error occurred in the server's part

Status Code	Description
200	OK
201	Created
202	Accepted (Request accepted, and queued for execution)
204	OK with no response object
400	Bad request
401	Authentication failure
403	Forbidden
404	Resource not found
405	Method Not Allowed
409	Conflict
412	Precondition Failed
413	Request Entity Too Large
500	Internal Server Error
501	Not Implemented
503	Service Unavailable