Documentation | API | Quick Reference

Introduction

The Authified API allow merchants to connect to the application programmatically. Merchant can request documents and information with variety of features listed, by creating a quiz and sending quiz url to the client. Once quiz completed by the client, merchant can retrieve the processed data by calling document API endpoints. The API itself is capable to update a webhook on different events for client's profile.

This document refers to few different personas:

Merchant - The person or program interacting with Authified API(you).
Client - The person(your customer) whose data is being requested by merchant(you).

Restful API

The API is organized around representational state transfer(REST) principles which involve requests and responses. You make request to web server and then web server make request to database server to get a stored resource. After getting the stored resource the web server responds with the requested information. The protocol used to transport the data is HTTP.

Application

Web Server

Database

Important URLs

Login - https://authified.com/login
Dashboard - https://authified.com/dashboard
API key and secret - https://authified.com/settings/merchant
Documentation - https://authified.com/documentation/quick-reference
API base - https://authified.com/api/v1

Requesting Information

All the requests made to API, supports http POST method only and will be served via HTTPS protocol. Every request made to API must be authenticated on server. You can see authentication process.The request consists of a JSON object with one or more of the fields. You can see the example request.

Endpoints

The list below explains various endpoints available and their methods. You can find request parameters, simple responses and other details in the links provided corresponds to the each endpoint.

Endpoint	Method	Authentication
/profile/create	POST	required
/profile/update	POST	required
/profile/read	POST	required
/profile/delete	POST	required
/profile/get	POST	required
/profile/update-status	POST	required
/document/read	POST	required
/document/delete	POST	required
/document/update-status	POST	required
/note/create	POST	required
/note/read	POST	required
/event/read	POST	required
/quiz/create	POST	required
/quiz/read	POST	required
/quiz/delete	POST	required
/quiz/get	POST	required
/quiz/expire	POST	required
/template/create	POST	required
/template/update	POST	required
/template/read	POST	required
/template/delete	POST	required
/template/get	POST	required

Features

The list below explains various features available on Authified with description. You can create a client/profile by requesting /profile/create and then request these features from your client by calling /quiz/create endpoints.

Name	Description
driver_licence_upload	Request a US/CAN driver's licence upload. A face and signature image with OCR read will be provided.
passport_upload	Request a US/CAN passport upload. A face and signature image with OCR read will be provided.
other_id_upload	Request an id upload. OCR read will be provided.
selfie_upload	Request to capture/upload selfie. A comparison confidence score will be provided, if a target image is available to compare.
bank_statement_upload	Request a bank statement upload. OCR read will be provided.
receipt_upload	Request a receipt upload. OCR read will be provided.
utility_bill_upload	Request a utility bill upload. OCR read will be provided.
void_check_upload	Request a bank void check upload. OCR read will be provided.
address_submit	Request address submit.
mobile_phone_submit	Request mobile phone submit.
email_address_submit	Request email address submit.
date_of_birth_submit	Request date of birth submit.
ssn_submit	Request SSN (Social Insurance Number) submit.
canadian_bank_validation	Request CAN bank login to validate account details. Account data with latest transactions will be provided.
usa_canadian_bank_validation	Request US/CAN bank login to validate account details. Account data with latest transactions will be provided.
agreement_sign	Request agreement to sign. Agreement and a signature image will be provided.
google_login	Request a google account login. A profile image, email address and name associate with account will be provided.
facebook_login	Request a facebook account login. A profile image, email address and name associate with account will be provided.
device_finger_print	Request a device fingerprint of current device. A unique device fingerprint and location will be provided.
custom_application	Request to fill out a custom application. Also request to generate and sign a PDF file. Before requesting a custom application, a custom application needs to be created under Authified Dashboard Settings Merchant Custom APP or here.
canadian_bank_statement	Request a CAN bank statement. Monthly account statement pdf files will be provided.
utility_statement	Request a utility provider login. Monthly account statement will be provided.

Last modified: 4 years ago

Simple Request Format 
{
    "merchant_reference": "",
    "customer_id": "",
    "first_name": "",
    "middle_name": "",
    "last_name": "",
    "date_of_birth": "",
    "email_address": "",
    "mobile_number": "",
    "home_phone_number": "",
    "ip_address": "",
    "address_line_1": "",
    "address_line_2": "",
    "city": "",
    "state": "",
    "postal": "",
    "country": "",
    "amount": "",
    "driver_licence_id": "",
    "ssn": ""
}

Simple Request Format 
{
    "merchant_reference": "",
    "customer_id": "",
    "first_name": "",
    "middle_name": "",
    "last_name": "",
    "date_of_birth": "",
    "email_address": "",
    "mobile_number": "",
    "home_phone_number": "",
    "ip_address": "",
    "address_line_1": "",
    "address_line_2": "",
    "city": "",
    "state": "",
    "postal": "",
    "country": "",
    "amount": "",
    "driver_licence_id": "",
    "ssn": ""
}

Simple Request Format 
{
    "merchant_reference": "",
    "customer_id": "",
    "first_name": "",
    "middle_name": "",
    "last_name": "",
    "date_of_birth": "",
    "email_address": "",
    "mobile_number": "",
    "home_phone_number": "",
    "ip_address": "",
    "address_line_1": "",
    "address_line_2": "",
    "city": "",
    "state": "",
    "postal": "",
    "country": "",
    "amount": "",
    "driver_licence_id": "",
    "ssn": ""
}

Simple Request Format 
{
    "merchant_reference": "",
    "customer_id": "",
    "first_name": "",
    "middle_name": "",
    "last_name": "",
    "date_of_birth": "",
    "email_address": "",
    "mobile_number": "",
    "home_phone_number": "",
    "ip_address": "",
    "address_line_1": "",
    "address_line_2": "",
    "city": "",
    "state": "",
    "postal": "",
    "country": "",
    "amount": "",
    "driver_licence_id": "",
    "ssn": ""
}

Simple Request Format 
{
    "merchant_reference": "",
    "customer_id": "",
    "first_name": "",
    "middle_name": "",
    "last_name": "",
    "date_of_birth": "",
    "email_address": "",
    "mobile_number": "",
    "home_phone_number": "",
    "ip_address": "",
    "address_line_1": "",
    "address_line_2": "",
    "city": "",
    "state": "",
    "postal": "",
    "country": "",
    "amount": "",
    "driver_licence_id": "",
    "ssn": ""
}

Simple Request Format 
{
    "merchant_reference": "",
    "customer_id": "",
    "first_name": "",
    "middle_name": "",
    "last_name": "",
    "date_of_birth": "",
    "email_address": "",
    "mobile_number": "",
    "home_phone_number": "",
    "ip_address": "",
    "address_line_1": "",
    "address_line_2": "",
    "city": "",
    "state": "",
    "postal": "",
    "country": "",
    "amount": "",
    "driver_licence_id": "",
    "ssn": ""
}