idfy-eve/php

This package is abandoned and no longer maintained. No replacement package was suggested.

There is no license information available for the latest version (dev-master) of this package.

Web SDK for Integration with IDfy (Tasks api)

dev-master 2018-10-16 13:26 UTC

Requires

• php: >=5.3.0

Unknown License

README

PHP WEB SDK

PHP package for integration with IDfy-API.

Util to request IDfy's Extraction and Verification Engine services.

##Installation

1. Ensure you have composer installed. Here is a link : https://getcomposer.org/download/
2. Add the following requirement to your composer.json file present in the project :
"require": {
        "idfy-eve/php": "dev-master"
    }
3. Run "composer require idfy-eve/sdk-php" from your project root directory
4. Add the following in your main php script:
    "require_once __DIR__ . '/vendor/autoload.php';"

##Client-Initiation

• Setup your API key in the dashboard - plans.idfy.com

$client = new Client($apikey="<YOUR API_KEY>", account_id="YOUR_ACCOUNT_ID");

Please ensure the API_KEY is included as a string.

###Usage

#####POST request

• Making API call to make service request.(Refer various services (or) task_types here - https://api-docs.idfy.com/v2/#task-types).

$client->post_request($task_type="pan_ocr", $task_id="4d4ggg87-53e5-4b6e-947a-04655eed588b",
            $data=array("doc_url"=> "https://tiimg.tistatic.com/fp/1/003/642/pan-card-ser554.jpg",);

• Mandatory arguments: task_type (string), task_id (string), data (dictionary)
• Optional arguments: group_id (string)
• Ensure the task_type is exactly mentioned as found in the doc.
• Strictly stick to the request-schema respective to the task_types mentioned in the doc.
• request_id in the response body is a unique-id, which will be used to query the response of the api-call.
• Response to the above API-request:

{
  "status": 202, 
  "request_id": "e53992c5-6d6f-4d85-bc36-07f7442f91bc"
}

#####GET response

• Making API call, to receive response from the request made in the above step. request_id - generated in the previous step, will be an argument to get the response.

Syntax : 
$client->get_response($request_id,$group_id,$task_id)

Example:
$client->get_response($request_id="e53992c5-6d6f-4d85-bc36-07f7442f91bc")
or
$client->get_response(null,$group_id="group-id")

• Mandatory argument(s) - request_id (string).
• Response from the above the API-call:

[
    {
        "status": "completed",
        "request_id": "e53992c5-6d6f-4d85-bc36-07f7442f91bc",
        "task_id": "4d48c187-53e5-4b6e-947a-04655eed588b",
        "group_id": "d468f87e-8e7b-4422-83eb-2edf4c1cfb95",
        "created_at": "2018-09-03T08:12:57+00:00",
        "completed_at": "2018-09-03T08:13:07+00:00",
        "tat": "10.081501662",
        "ocr_output": {
            "pan_number": "BJAPS7****",
            "pan_type": "Individual",
            "name_on_card": "Sr*****",
            "fathers_name": "Ven*******",
            "date_on_card": "1984-04-07",
            "date_of_issue": "2006-12-27",
            "age": 34,
            "is_scanned": false,
            "minor": false,
            "raw_text": "INCOME TAX DEPARTMENT\nGOVT OF INDIA\nSRXXXXXXX G V\nVEN********\n07/04/1984\nPermanent Account Number\nBJAPSXXXX\nSignature\n"
        }
    }
]