Documentation | API | Endpoints | Template

Documentation | API | Endpoints | Template | Create

TemplateCreate

The endpoint allows you to create a new template. A json object is required to be posted as raw body. See example request, response objects and authentication process. The full API URL is :

POST https://authified.com/api/v1/template/create

Query Parameters

Name	Type	Description
/template_name	string(100)	Provide a name to template - (required)
/list	array	A template list of features available - (required)
/driver_licence_upload	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/passport_upload	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/other_id_upload	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/selfie_upload	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/bank_statement_upload	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/receipt_upload	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/utility_bill_upload	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/void_check_upload	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/address_submit	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/mobile_phone_submit	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/email_address_submit	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/date_of_birth_submit	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/ssn_submit	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/canadian_bank_validation	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/usa_canadian_bank_validation	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/agreement_sign	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/google_login	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/facebook_login	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/device_finger_print	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/custom_application	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/canadian_bank_statement	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)
/utility_statement	int(1)	Valid options are 0 (not required), 1 (required) or 2 (optional)

Please, to send request.

{
    "template_name": "",
    "list": {
        "driver_licence_upload": 0,
        "passport_upload": 0,
        "other_id_upload": 0,
        "selfie_upload": 0,
        "bank_statement_upload": 0,
        "receipt_upload": 0,
        "utility_bill_upload": 0,
        "void_check_upload": 0,
        "address_submit": 0,
        "mobile_phone_submit": 0,
        "email_address_submit": 0,
        "date_of_birth_submit": 0,
        "ssn_submit": 0,
        "canadian_bank_validation": 0,
        "usa_canadian_bank_validation": 0,
        "agreement_sign": 0,
        "google_login": 0,
        "facebook_login": 0,
        "device_finger_print": 0,
        "custom_application": 0,
        "canadian_bank_statement": 0,
        "utility_statement": 0
    }
}

{
    "http_status_code": 201,
    "query_reference_id": "",
    "response_time": 0,
    "query_at": "",
    "template_id": "",
    "template_name": "",
    "list": {
        "driver_licence_upload": 0,
        "passport_upload": 0,
        "other_id_upload": 0,
        "selfie_upload": 0,
        "bank_statement_upload": 0,
        "receipt_upload": 0,
        "utility_bill_upload": 0,
        "void_check_upload": 0,
        "address_submit": 0,
        "mobile_phone_submit": 0,
        "email_address_submit": 0,
        "date_of_birth_submit": 0,
        "ssn_submit": 0,
        "canadian_bank_validation": 0,
        "usa_canadian_bank_validation": 0,
        "agreement_sign": 0,
        "google_login": 0,
        "facebook_login": 0,
        "device_finger_print": 0,
        "custom_application": 0,
        "canadian_bank_statement": 0,
        "utility_statement": 0
    },
    "created_at": "",
    "updated_at": ""
}

Last modified: 4 years ago

curl --location --request POST 'https://authified.com/api/v1/template/create' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Api-Key: ' \
--header 'Signature: ' \
--data-raw '{
       "template_name": "",
        "list": {
            "driver_licence_upload": 0,
            "passport_upload": 0,
            "other_id_upload": 0,
            "selfie_upload": 0,
            "bank_statement_upload": 0,
            "receipt_upload": 0,
            "utility_bill_upload": 0,
            "void_check_upload": 0,
            "address_submit": 0,
            "mobile_phone_submit": 0,
            "email_address_submit": 0,
            "date_of_birth_submit": 0,
            "ssn_submit": 0,
            "canadian_bank_validation": 0,
            "usa_canadian_bank_validation": 0,
            "agreement_sign": 0,
            "google_login": 0,
            "facebook_login": 0,
            "device_finger_print": 0,
            "custom_application": 0,
            "canadian_bank_statement": 0,
            "utility_statement": 0
        }
    }'

POST /api/v1/template/create HTTP/1.1
Host: https://authified.com
Accept: application/json
Content-Type: application/json
Api-Key: 
Signature: 
Content-Length: 
{
    "template_name": "",
    "list": {
        "driver_licence_upload": 0,
        "passport_upload": 0,
        "other_id_upload": 0,
        "selfie_upload": 0,
        "bank_statement_upload": 0,
        "receipt_upload": 0,
        "utility_bill_upload": 0,
        "void_check_upload": 0,
        "address_submit": 0,
        "mobile_phone_submit": 0,
        "email_address_submit": 0,
        "date_of_birth_submit": 0,
        "ssn_submit": 0,
        "canadian_bank_validation": 0,
        "usa_canadian_bank_validation": 0,
        "agreement_sign": 0,
        "google_login": 0,
        "facebook_login": 0,
        "device_finger_print": 0,
        "custom_application": 0,
        "canadian_bank_statement": 0,
        "utility_statement": 0
    }
}

var settings = {
    "url": "https://authified.com/api/v1/template/create",
    "method": "POST",
    "timeout": 0,
    "headers": {
      "Accept": "application/json",
      "Content-Type": "application/json",
      "Api-Key": "",
      "Signature": ""
    },
    "data": JSON.stringify({
        "template_name": "",
        "list": {
            "driver_licence_upload": 0,
            "passport_upload": 0,
            "other_id_upload": 0,
            "selfie_upload": 0,
            "bank_statement_upload": 0,
            "receipt_upload": 0,
            "utility_bill_upload": 0,
            "void_check_upload": 0,
            "address_submit": 0,
            "mobile_phone_submit": 0,
            "email_address_submit": 0,
            "date_of_birth_submit": 0,
            "ssn_submit": 0,
            "canadian_bank_validation": 0,
            "usa_canadian_bank_validation": 0,
            "agreement_sign": 0,
            "google_login": 0,
            "facebook_login": 0,
            "device_finger_print": 0,
            "custom_application": 0,
            "canadian_bank_statement": 0,
            "utility_statement": 0
        }
    }),
  };
  
  $.ajax(settings).done(function (response) {
    console.log(response);
  });

var data = JSON.stringify({
    "template_name": "",
    "list": {
        "driver_licence_upload": 0,
        "passport_upload": 0,
        "other_id_upload": 0,
        "selfie_upload": 0,
        "bank_statement_upload": 0,
        "receipt_upload": 0,
        "utility_bill_upload": 0,
        "void_check_upload": 0,
        "address_submit": 0,
        "mobile_phone_submit": 0,
        "email_address_submit": 0,
        "date_of_birth_submit": 0,
        "ssn_submit": 0,
        "canadian_bank_validation": 0,
        "usa_canadian_bank_validation": 0,
        "agreement_sign": 0,
        "google_login": 0,
        "facebook_login": 0,
        "device_finger_print": 0,
        "custom_application": 0,
        "canadian_bank_statement": 0,
        "utility_statement": 0
    }
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://authified.com/api/v1/template/create");
xhr.setRequestHeader("Accept", "application/json");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Api-Key", "");
xhr.setRequestHeader("Signature", "");

xhr.send(data);

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => "https://authified.com/api/v1/template/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>'{
    "template_name": "",
    "list": {
        "driver_licence_upload": 0,
        "passport_upload": 0,
        "other_id_upload": 0,
        "selfie_upload": 0,
        "bank_statement_upload": 0,
        "receipt_upload": 0,
        "utility_bill_upload": 0,
        "void_check_upload": 0,
        "address_submit": 0,
        "mobile_phone_submit": 0,
        "email_address_submit": 0,
        "date_of_birth_submit": 0,
        "ssn_submit": 0,
        "canadian_bank_validation": 0,
        "usa_canadian_bank_validation": 0,
        "agreement_sign": 0,
        "google_login": 0,
        "facebook_login": 0,
        "device_finger_print": 0,
        "custom_application": 0,
        "canadian_bank_statement": 0,
        "utility_statement": 0
    }
}',
  CURLOPT_HTTPHEADER => array(
    "Accept: application/json",
    "Content-Type: application/json",
    "Api-Key: ",
    "Signature: "
  ),
));
$response = curl_exec($curl);
$http_code = curl_getinfo($url, CURLINFO_HTTP_CODE);
curl_close($url);
if ($http_code === 200):
    echo $response;
else:
    echo "Un-expected server response http_code($http_code)<br/>$response";
endif;

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://authified.com/api/v1/template/create');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Accept' => 'application/json',
  'Content-Type' => 'application/json',
  'Api-Key' => '',
  'Signature' => ''
));
$request->setBody('{
    "template_name": "",
    "list": {
        "driver_licence_upload": 0,
        "passport_upload": 0,
        "other_id_upload": 0,
        "selfie_upload": 0,
        "bank_statement_upload": 0,
        "receipt_upload": 0,
        "utility_bill_upload": 0,
        "void_check_upload": 0,
        "address_submit": 0,
        "mobile_phone_submit": 0,
        "email_address_submit": 0,
        "date_of_birth_submit": 0,
        "ssn_submit": 0,
        "canadian_bank_validation": 0,
        "usa_canadian_bank_validation": 0,
        "agreement_sign": 0,
        "google_login": 0,
        "facebook_login": 0,
        "device_finger_print": 0,
        "custom_application": 0,
        "canadian_bank_statement": 0,
        "utility_statement": 0
    }
}');
try {
  $response = $request->send();
  if ($response->getStatus() === 200) {
    echo $response->getBody();
  } else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}