IDfy’s API suite can be used as granular pieces that help you build a seamless, quick, and scalable KYC and onboarding process, irrespective of your industry or business.
\nThis page will help you understand:
\nHow to set up your account
\nThe range of IDfy API solutions
\nAuthentication of your APIs
\nSome key terms related to each of the APIs
\nDocumentation of each API
\nTo run our APIs, you need an api-key and an account-id. If you don’t have these yet, please get in touch with us at eve.support@idfy.com for us to create an account for you.
\nIDfy offers a wide range of APIs that cover all aspects of your onboarding and authentication journeys. IDfy API solutions are:
\n
Allows you to verify the legitimacy of an identity by verifying it with the originating source itself (for example, against a government database)
Allows you to perform a set of checks to verify the authenticity of an end-user
Allows you to perform Advanced AI / ML based checks to verify a user
Allows you to use IDfy’s video based solutions
Every request must contain headers identifying the API account as specified in the Authentication section. An API account is an entity used for authentication, authorization and tracking usage of our APIs. It consists of an account-id and api-key.
\nYou can start using our APIs in 3 simple steps:
\nYou’re all set!
\nThe APIs are granular in nature, and can fit in all types of workflows. Our APIs are modelled around the concept of tasks. Each capability is a task type. Your servers create tasks by hitting our Tasks Endpoints over HTTP. These tasks are bucketed across various sections like:
\nIDs which you can assign to identify your tasks. We recommend setting a unique Task ID (preferably UUID v4) for every task. You could use group ID to group your tasks as per your convenience (generally used to group tasks for a profile).
\nA unique ID which we assign to every task we receive from you. We recommend that you store this request ID
\nWe use Webhooks to send the output of our APIs to an endpoint on your server. Each webhook refers to only one task and is called when a task gets completed, either successfully or with an error. Webhooks can be configured by emailing us at eve.support@idfy.com.
\nURLs of documents, or Documents as base64 encoded strings (Recommended size is less than 1 MB). You could also send us URLs of documents hosted on your servers. These URLs need to be accessible to our servers, but can be protected against unauthorised access using some or all of the mechanisms below.
\nUse URLs which expire after a brief period of time Whitelist the IPs of our servers which fetch documents from your servers Pre-configure custom authentication headers which we could attach to every request we make to fetch documents from your service
\nThere are 2 modes of operation - synchronous and asynchronous. Most tasks can be called using either APIs. Synchronous APIs return the response right away:
\n![](\"https://eve-docs.idfy.com/assets/images/synchronus_mode.png\")
\n\nAsynchronous APIs return a request ID and use a webhook mechanism to return the response back to your servers. You can then use this request ID and feed this into our GET API to consume the response.
\n| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
![](\"https://eve-docs.idfy.com/assets/images/asynchronus_mode.png\")
\n\nPlease refer to this document for understanding the integration procedure of IDfy's APIs.
\nExample the lowest resolution for livness is 200x200
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Code Legends","slug":"code-legends"},{"content":"Integration Process","slug":"integration-process"},{"content":"FAQ","slug":"faq"}],"owner":"11914481","collectionId":"6797c328-e461-464a-951e-35596f09ddca","publishedId":"2s8Z6zzXNf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-05-09T08:55:41.000Z"},"item":[{"name":"Document Solutions","item":[{"name":"Extraction (OCR)","item":[{"name":"India","item":[{"name":"Individual","item":[{"name":"Async","item":[{"name":"Ind_PAN Async","item":[{"name":"ind_pan async","id":"f85fd504-623f-4479-8ece-db61939c41db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"account-id","type":"text","value":"{{account-id}}"},{"key":"api-key","type":"text","value":"{{api-key}}"}],"body":{"mode":"raw","raw":"{\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"data\": {\n \"document1\": \"URL/Base64\"\n }\n}"},"url":"https://eve.idfy.com/v3/tasks/async/extract/ind_pan","description":"Extraction of details from image of an individual or company PAN card in real-time. You can additionally send more details in the request to perform a name match with the extracted fields.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with the below parameters | The details of the data required to perform the task. | Yes |
data.document1 | string | image in base64 format OR URL of the image of PAN card (Recommended image size: 2MB - 3MB) | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid while making a call to this Get Task API.
\nAadhar OCR is used to extract details from the image of an individual Aadhaar card in real-time. Additional details can be sent in API request to perform a name, street address, district, (Aadhar number) match with the extracted fields. Aadhar card is used as Proof of Address (POA) and Proof of Identity(POI)
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/URL | image in base64 format OR URL of image of Aadhar card (front). Recommended image size: 2MB - 3MB | Yes |
data.document2 | base64/URL | image in base64 format OR URL of image of Aadhar card (back). Recommended image size: 2MB - 3MB | Yes |
consent | string | Enum: \"yes\" \"no\". Consent by the user to extract his/her information from his/her aadhaar card | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API gives you the user's Aadhaar details in the response body.
\nExtraction of details from image of an indian driving license in real-time. You can additionally send more details in the request to perform a name match with the extracted fields.
\n| Key | \nType | \nDetails | \nMandatory | \n
|---|---|---|---|
| task_id | \nstring | \nThe unique identifier of a requested task provided by you. | \nYes | \n
| group_id | \nstring | \nThe unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | \nYes | \n
| data | \nObject with below parameters | \nThe details of the data required to perform the task. | \nYes | \n
| document1 | \nbase64/string | \nimage in base64 format OR URL of image of driving license (front). These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms.\n | \nYes | \n
| document2 | \nbase64/string | \nimage in base64 format OR URL of image of driving license (back). These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms.\n | \nYes | \n
| Key | \nType | \nDetails | \n
|---|---|---|
| request_id | \nstring | \nUUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" | \n
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API gives you the user's Driving License details in the response body.
\nExtraction of details from image of a Voter ID card in real-time. You can additionally send more details in the request to perform a name match with the extracted fields.
\n| Key | \nType | \nDetails | \nMandatory | \n
|---|---|---|---|
| task_id | \nstring | \nThe unique identifier of a requested task provided by you. | \nYes | \n
| group_id | \nstring | \nThe unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | \nYes | \n
| data | \nObject with below parameters | \nThe details of the data required to perform the task. | \nYes | \n
| document1 | \nbase64/string | \nimage in base64 format OR URL of image of voter ID (front). These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms.\n | \nYes | \n
| document2 | \nbase64/string | \nURL of the image (voter ID back) - either expiring or publicly accessible url | \nNo | \n
| Key | \nType | \nDetails | \n
|---|---|---|
| request_id | \nstring | \nUUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" | \n
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API gives you the user's Voter ID details in the response body.
\nExtraction of details from image of an Indian passport card in real-time. You can additionally send more details in the request to perform a name match with the extracted fields.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
document2 | base64/string | URL of the image (passport back) - either expiring or publicly accessible url | No |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API gives you the user's Passport details in the response body.
\nIDfy’s Vaccination OCR API allows you to extract and digitize the details from a COVID-19 Vaccine certificate (PDF) that is downloaded from Co-win. Our Machine learning algorithms help you digitize this data within a matter of seconds, enabling you to have much more accurate data and save operational costs.
\n| Key | \nType | \nDetails | \n
|---|---|---|
| task_id | \nstring | \nThe unique identifier of a requested task provided by you. | \n
| group_id | \nstring | \nThe unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | \n
| data | \nObject with below parameters | \nThe details of the data required to perform the task. | \n
| document1 | \nstring | \nURL / BASE64 of the Vaccination certificate PDF | \n
| Key | \nType | \nDetails | \n
|---|---|---|
| request_id | \nstring | \nUUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" | \n
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API gives you the user's PAN details in the response body.
\n","urlObject":{"protocol":"https","path":["v3","tasks"],"host":["eve","idfy","com"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}],"variable":[]}},"response":[{"id":"10211d86-a30a-4e46-a7ff-53645588c7f5","name":"Success: Get task","originalRequest":{"method":"GET","header":[{"key":"api-key","type":"text","value":"{{api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"account-id","type":"text","value":"{{account-id}}"}],"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=2817f4d7-e9cd-4577-be53-671ed83933bc","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"2817f4d7-e9cd-4577-be53-671ed83933bc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"content-length","value":"375"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"date","value":"Fri, 04 Nov 2022 08:54:59 GMT"},{"key":"server","value":"idfy"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"action\": \"extract\",\n \"completed_at\": \"2022-11-04T14:24:38+05:30\",\n \"created_at\": \"2022-11-04T14:24:37+05:30\",\n \"error\": \"UNSUPPORTED_FILE_FORMAT\",\n \"group_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"message\": \"Unsupported file format\",\n \"request_id\": \"2817f4d7-e9cd-4577-be53-671ed83933bc\",\n \"status\": \"failed\",\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"type\": \"ind_vaccination_cert\"\n }\n]"},{"id":"0262cd9a-2b4c-463c-92a5-f9cc0bc2cd05","name":"Err: Invalid request ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"api-key","type":"text","value":"{{api-key}}"},{"key":"account-id","type":"text","value":"1234567"}],"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=54abe5cb-d7b2-49dc-856f-f1e7c4760689...","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"54abe5cb-d7b2-49dc-856f-f1e7c4760689..."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"content-length","value":"45"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"date","value":"Fri, 21 Oct 2022 10:23:35 GMT"},{"key":"server","value":"idfy"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The requested id does not exist\"\n}"},{"id":"064d8f7d-9dc8-4dd4-ba3d-4447ee879d08","name":"Err: Missing API Key","originalRequest":{"method":"GET","header":[{"key":"api-key","type":"text","value":"{{api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"account-id","type":"text","value":"{{account-id}}"}],"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"content-type","value":"text/plain"},{"key":"content-length","value":"41"},{"key":"x-idfy-gateway-id","value":"eve-gateway"},{"key":"date","value":"Thu, 27 Oct 2022 09:49:17 GMT"},{"key":"server","value":"idfy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"No API key found in request\"}"},{"id":"db95c78e-d2af-497d-a9bf-86a002cd114b","name":"Err: Invalid Authentication","originalRequest":{"method":"GET","header":[{"key":"api-key","type":"text","value":"{{api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"account-id","type":"text","value":"{{account-id}}"}],"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"content-type","value":"text/plain"},{"key":"content-length","value":"48"},{"key":"x-idfy-gateway-id","value":"eve-gateway"},{"key":"date","value":"Thu, 27 Oct 2022 09:49:52 GMT"},{"key":"server","value":"idfy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Invalid authentication credentials\"}"}],"_postman_id":"35857e66-8000-4b49-b617-1840731be9f3"}],"id":"a0d01143-08d5-4e9b-a751-a292a7236ddb","_postman_id":"a0d01143-08d5-4e9b-a751-a292a7236ddb","description":""},{"name":"ind_aadhaar_plus","item":[{"name":"ind_aadhaar_plus async","id":"7d2c3748-d19f-492a-b805-2eb8bb28b3bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"account-id","type":"text","value":"{{account-id}}"},{"key":"api-key","type":"text","value":"{{api-key}}"}],"body":{"mode":"raw","raw":"{\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"group_id\": \"aadhaar_ocr_plus\",\n \"data\": {\n \"document1\": \"URL/Base64\",\n \"document2\": \"URL/Base64\",\n \"consent\": \"yes\",\n \"advanced_details\": { \n \"extract_qr_info\": true, \n \"extract_last_4_digit\":true \n }\n }\n}"},"url":"https://eve.idfy.com/v3/tasks/async/extract/ind_aadhaar_plus","description":"Extraction of details from image of an Aadhaar card in real-time. You can additionally send more details in the request to perform QR detection, QR data extraction.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
document1 | base64/string | image in base64 format OR URL of image of Aadhaar card (front) | Yes |
document2 | base64/string | image in base64 format OR URL of image of Aadhaar card(back) | No |
consent | string | Enum: \"yes\" \"no\". Consent by the user | Yes |
extract_qr_info | bool | Additional input to extract full name in split form | No |
extract_last_4_digit | bool | Additional input to extract only last four digits of aadhaar number | No |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API gives you the user's Aadhaar details in the response body.
\nExtraction of details from image of an individual or company PAN card in realtime.
\n| Key | Type | Details | Mandatory | |
|---|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes | |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes | |
data | Object with the below parameters | The details of the data required to perform the task. | Yes | |
document1 | string | image in base64 format OR URL of the image of PAN card (front) | Yes |
Extraction of details from image of an Aadhaar card in real-time.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
document1 | base64/string | image in base64 format OR URL of image of Aadhaar card (front) | Yes |
document2 | base64/string | image in base64 format OR URL of image of Aadhaar card(back) | No |
consent | string | Enum: \"yes\" \"no\". Consent by the user | Yes |
Extraction of details from image of an indian driving license in real-time. You can additionally send more details in the request to perform a name match with the extracted fields.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
document1 | base64/string | image in base64 format OR URL of image of driving license (front). These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
document2 | base64/string | image in base64 format OR URL of image of driving license (back). These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | No |
Extraction of details from image of an Aadhaar card in real-time. You can additionally send more details in the request to perform QR detection, QR data extraction.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
document1 | base64/string | image in base64 format OR URL of image of Aadhaar card (front) | Yes |
document2 | base64/string | image in base64 format OR URL of image of Aadhaar card(back) | No |
consent | string | Enum: \"yes\" \"no\". Consent by the user | Yes |
extract_qr_info | bool | true/false | No |
extract_last_4_digit | bool | true/false | No |
Extraction of details from image of a Voter ID card in real-time. You can additionally send more details in the request to perform a name match with the extracted fields.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
document1 | base64/string | image in base64 format OR URL of image of voter ID (front). These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
document2 | base64/string | URL of the image (voter ID back) - either expiring or publicly accessible url | No |
details | object | Pass this object to compare against extracted values of name, address, dob, and number | No |
Extraction of details from image of an Indian passport card in real-time. You can additionally send more details in the request to perform a name match with the extracted fields.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
document1 | base64/string | image in base64 format OR URL of image of passport (front). These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
document2 | base64/string | URL of the image (passport back)- either expiring or publicly accessible url | No |
IDfy’s Vaccination OCR API allows you to extract and digitize the details from a COVID-19 Vaccine certificate (PDF) that is downloaded from Co-win. Our Machine learning algorithms help you digitize this data within a matter of seconds, enabling you to have much more accurate data and save operational costs.
\n| Key | \nType | \nDetails | \n
|---|---|---|
| task_id | \nstring | \nThe unique identifier of a requested task provided by you. | \n
| group_id | \nstring | \nThe unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | \n
| data | \nObject with below parameters | \nThe details of the data required to perform the task. | \n
| document1 | \nstring | \nURL / BASE64 of the Vaccination certificate PDF | \n
| Key | \nType | \nDetails | \n
|---|---|---|
| action | \nstring | \nValue: \"verify_with_source\" | \n
| type | \nstring | \nValue: “domain” | \n
| status | \nstring | \nEnum: \"completed\", \"in_progress\", \"failed\" Current status of the task | \n
| request_id | \nstring | \nThe unique identifier assigned to the requested task, provided by us. | \n
| task_id | \nstring | \nThe unique identifier of a requested task provided by you. | \n
| group_id | \nstring | \nThe unique identifier of a group of tasks provided by you. | \n
| created_at | \nstring | \nTimestamp (ISO 8601 format) when the task was created | \n
| completed_at | \nstring | \nTimestamp (ISO 8601 format) when the task was completed | \n
| result | \nobject | \nObject containing the extraction output | \n
| extraction_output | \nobject | \nObject containing extracted details | \n
| beneficiary_name | \nstring | \nExtracted name of the beneficiary as mentioned in the certificate | \n
| beneficiary_reference_id | \nstring | \nExtracted beneficiary_id as mentioned in the certificate | \n
| age | \nstring | \nAge of the beneficiary as mentioned in the vaccine certificate | \n
| gender | \nstring | \nGender of the beneficiary as mentioned in the vaccine certificate | \n
| total_doses_received | \nstring | \nTotal doses received by the beneficiary as mentioned in the certificate | \n
| id_verified | \nstring | \nID card used by the beneficiary | \n
| id_verified_number | \nstring | \nMasked ID number of the beneficiary | \n
| unique_health_id | \nstring | \nMasked Unique health id of the beneficiary | \n
| vaccinated_by | \nstring | \nName of the health worker who vaccinated the beneficiary | \n
| vaccinated_at | \nstring | \nName of the vaccination centre | \n
| vaccine_name | \nstring | \nName of the vaccine that was administered | \n
| vaccination_for | \nstring | \nName of the condition that the user was vaccinated against | \n
| dates | \nobject | \nObject containing vaccination administered dates | \n
| doc_type | \nstring | \nDocument type sent by the user | \n
This section contains checks that are applicable to Individuals
\n","_postman_id":"db736102-dede-4617-bec4-badc95d64270"},{"name":"Merchant","item":[{"name":"Async","item":[{"name":"ind_Udyog _Aadhaar","item":[{"name":"india_udyog async","id":"b18864ce-4b79-4b9d-af02-d0afaf993c13","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"data\": {\n \"document1\": \"URL / BASE64\"\n }\n}"},"url":"https://eve.idfy.com/v3/tasks/async/extract/ind_udyog_aadhaar","description":"Extraction of details from image of an Udyog Aadhaar Certificate in real-time.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of driving license. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API gives you the user's GST Udyog details in the response body.
\nExtraction of details from image of a GST Certificate in real-time.
\n| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API gives you the user's GST Certificate details in the response body.
\nExtraction of details from image of a GST Certificate in real-time.
\nExtraction of details from image of an Udyog Aadhaar Certificate in real-time.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
document1 | base64/string | image in base64 format OR URL of image of driving license. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
Extraction of details from image of an Indian cheque in real-time. You can additionally send more details in the request to perform a name match with the extracted fields.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
document1 | base64/string | image in base64 format OR URL of image of driving license. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
micr_details | string | Enum: \"true\" \"false\". Pass this key with value \"true\" to get MICR cheque number & MICR code | No |
Extraction of details from image of an Indian Registration Certificate (RC) in real-time.
\nThe API also provides the option to match the name of vehicle owner that has been captured in a use-case against the name of vehicle owner on the database
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
document1 | string | The URL of the document image (RC front). These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
document2 | string | The URL of the document image (RC back). These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | No |
Extraction of details from image of an Indian Registration Certificate (RC) in real-time.
\n| Key | \nType | \nDetails | \nMandatory | \ntask_id | \nstring | \nThe unique identifier of a requested task provided by you. | \nYes | \n \n
|---|---|---|---|
| group_id | \nstring | \nThe unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | \nYes | \n
| data | \nObject with below parameters | \nThe details of the data required to perform the task. | \nYes | \n
| document1 | \nstring | \nThe URL of the document image (RC Front). These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | \nYes | \n
| document2 | \nstring | \nThe URL of the document image (RC Back). These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | \nNo | \n
| Key | \nType | \nDetails | \n
|---|---|---|
| request_id | \nstring | \nUUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" | \n
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API gives you the user's PAN details in the response body.
\nExtraction of details from image of an Indian cheque in real-time. You can additionally send more details in the request to perform a name match with the extracted fields.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
document1 | base64/string | image in base64 format OR URL of image of driving license. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
micr_details | string | Enum: \"true\" \"false\". Pass this key with value \"true\" to get MICR cheque number & MICR code | No |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API gives you the user's PAN details in the response body.
\nThis section specifically contains Indian documents.
\n","_postman_id":"75dd7d12-a061-469c-81f9-8b3f6a9b3298"},{"name":"Philippines","item":[{"name":"Async","item":[{"name":"phl_voter async","item":[{"name":"phl_voter async","id":"5b94946e-eb80-4642-ad62-25b1885c0715","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"task_id\" : \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"group_id\" : \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"data\" : {\n \"document1\" : \"Extracts data from Philippines Voter ID:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of voter ID. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nExtraction of details from Philippines driving license in real-time.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of driving license. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nExtracts data from Philippines - SSS (Social Security System):
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of SS Card. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nExtracts data from Philippines - TIN:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of TIN. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nExtracts data from Philippines - Passport:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nExtracts data from Philippines - Philsys:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
document2 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nExtracts the following data from Philippines - PRC:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
data.document2 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nExtracts data from Philippines - Philhealth:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nExtracts data from Philippines - NBI:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nExtracts data from Philippines - Philpost:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nExtracts data from Philippines - DTI:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
data.doc_type | string | must be: \"phl_dti\" | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nExtracts data from Philippines - BIR:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
data.doc_type | string | must be: \"phl_bir\" | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nExtracts data from Philippines Voter ID:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of voter ID. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
Extraction of details from Philippines driving license in real-time.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of driving license. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
Extracts data from Philippines - SSS (Social Security System):
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of SS card. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
Extracts data from Philippines - TIN:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of TIN. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
Extracts data from Philippines - UMID:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
Extracts following data from Philippines - PRC:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
Extracts data from Philippines - Philsys:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
data.document2 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
Extracts data from Philippines - Passport:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
Extracts data from Philippines - NBI:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
Extracts the following data from Philippines - Philpost:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
Extracts data from Philippines - DTI:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
data.doc_type | string | must be: \"phl_dti\" | Yes |
Extracts the following data from Philippines - BIR:
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of passport. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
data.doc_type | string | must be: \"phl_bir\" | Yes |
Extracts the following data from Philippines - PAG-IBIG:
\nExtracts the following data from Philippines - OFW card:
\nExtracts the following data from Philippines - ACR card:
\nExtracts the following data from Philippines - AEP card:
\nExtracts the following data from Philippines - Barangay ID card:
\nExtracts the following data from Philippines - Barangay Certificate:
\nExtracts the following data from Philippines - Police Clearance Certificate:
\nExtracts the following data from Philippines - Senior Citizen Card:
\nExtracts the following data from Philippines - SEC Card:
\nExtracts the following data from Philippines - AOI Card:
\nExtracts the following data from Philippines - AOP Card:
\nExtracts following data from Vietnam - NID:
\n| Key | \nType | \nDetails | \nMandatory | \n
|---|---|---|---|
| task_id | \nstring | \nThe unique identifier of a requested task provided by you. | \nYes | \n
| group_id | \nstring | \nThe unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | \nYes | \n
| data | \nObject with below parameters | \nThe details of the data required to perform the task. | \nYes | \n
| document1 | \nbase64/string | \nimage in base64 format OR URL of image of NID. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms.\n | \nYes | \n
| Key | \nType | \nDetails | \n
|---|---|---|
| request_id | \nstring | \nUUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" | \n
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API gives you the user's PAN details in the response body.
\n","urlObject":{"protocol":"https","path":["v3","tasks"],"host":["eve","idfy","com"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}],"variable":[]}},"response":[{"id":"cda2220a-5866-4839-abb5-d0f8b22a5be6","name":"Success","originalRequest":{"method":"GET","header":[{"key":"api-key","type":"text","value":"{{api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"account-id","type":"text","value":"{{account-id}}"}],"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=657f0de8-9471-4ed7-af87-207f643b0c6b","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"657f0de8-9471-4ed7-af87-207f643b0c6b"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"content-length","value":"526"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"date","value":"Mon, 07 Nov 2022 20:08:48 GMT"},{"key":"server","value":"idfy"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"action\": \"extract\",\n \"completed_at\": \"2022-11-08T01:38:35+05:30\",\n \"created_at\": \"2022-11-08T01:38:30+05:30\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"request_id\": \"657f0de8-9471-4ed7-af87-207f643b0c6b\",\n \"result\": {\n \"extraction_output\": {\n \"address\": \"Qué\",\n \"date_of_birth\": null,\n \"date_of_expiry\": null,\n \"gender\": null,\n \"hometown\": null,\n \"id_number\": \"001183000001\",\n \"name_on_card\": \"LÊ THỊ HỒNG VƯƠNG gọi khác\",\n \"year_of_birth\": \"2027\"\n }\n },\n \"status\": \"completed\",\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"type\": \"vietnam_nid\"\n }\n]"},{"id":"a0ea43a9-4230-484d-8846-ba4007b5cb60","name":"Err: Invalid request ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"api-key","type":"text","value":"{{api-key}}"},{"key":"account-id","type":"text","value":"{{account-id}}"}],"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=54abe5cb-d7b2-49dc-856f-f1e7c4760689...","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"54abe5cb-d7b2-49dc-856f-f1e7c4760689..."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"content-length","value":"45"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"date","value":"Fri, 21 Oct 2022 10:23:35 GMT"},{"key":"server","value":"idfy"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The requested id does not exist\"\n}"},{"id":"e532733b-f324-4ef3-bf99-7678323d624d","name":"Err: Missing API Key","originalRequest":{"method":"GET","header":[{"key":"api-key","type":"text","value":"{{api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"account-id","type":"text","value":"{{account-id}}"}],"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"content-type","value":"text/plain"},{"key":"content-length","value":"41"},{"key":"x-idfy-gateway-id","value":"eve-gateway"},{"key":"date","value":"Thu, 27 Oct 2022 09:49:17 GMT"},{"key":"server","value":"idfy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"No API key found in request\"}"},{"id":"c5df8431-a4c0-4bb9-80c7-ee99c5702065","name":"Err: Invalid Authentication","originalRequest":{"method":"GET","header":[{"key":"api-key","type":"text","value":"{{api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"account-id","type":"text","value":"{{account-id}}"}],"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"plain","header":[{"key":"content-type","value":"text/plain"},{"key":"content-length","value":"48"},{"key":"x-idfy-gateway-id","value":"eve-gateway"},{"key":"date","value":"Thu, 27 Oct 2022 09:49:52 GMT"},{"key":"server","value":"idfy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Invalid authentication credentials\"}"}],"_postman_id":"243e285c-be20-402d-8995-e15080d4ee8e"}],"id":"c86a5234-a399-4a88-a1aa-0c8198d465a3","_postman_id":"c86a5234-a399-4a88-a1aa-0c8198d465a3","description":""},{"name":"Sync","item":[{"name":"vietnam_nid sync","id":"74a97686-f5c8-41d7-8b9c-80c139ca7442","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"account-id","value":"{{account-id}}","type":"text"},{"key":"api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"task_id\" : \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"group_id\" : \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"data\" : {\n \"document1\": \"URL / BASE64\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://eve.idfy.com/v3/tasks/sync/extract/vietnam_nid","description":"Extracts following data from Vietnam - NID:
\n| Key | \nType | \nDetails | \nMandatory | \n
|---|---|---|---|
| task_id | \nstring | \nThe unique identifier of a requested task provided by you. | \nYes | \n
| group_id | \nstring | \nThe unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | \nYes | \n
| data | \nObject with below parameters | \nThe details of the data required to perform the task. | \nYes | \n
| document1 | \nbase64/string | \nimage in base64 format OR URL of image of NID. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms.\n | \nYes | \n
| Key | \nType | \nDetails | \n
|---|---|---|
| address | \nstring | \nAddress on ID card | \n
| date_of_birth | \nstring | \nDate of birth on ID card (YYYY-MM-DD) | \n
| date_of_expiry | \nstring | \nDate of expiry on ID card (YYYY-MM-DD) | \n
| gender | \nstring | \nGender on ID card (\"Male\" or \"Female\") | \n
| hometown | \nstring | \nHometown on ID card | \n
| id_number | \nstring | \nID number on ID card | \n
| name_on_card | \nstring | \nName on ID card | \n
| year_of_birth | \nstring | \nYear of Birth on ID card | \n
This API extracts details from KTP document of Indonesia
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of KTP. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nThis API extracts details from driving license document of Indonesia
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of driving license. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nThis API extracts details from KTP document of Indonesia
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of KTP. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
This API extracts details from driving license document of Indonesia
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of driving license. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
This API extracts details from Family Card document of Indonesia
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | base64/string | image in base64 format OR URL of image of driving license. These URL could either be expiring shortly or publicly accessible. You can also send us URLs hosted on your servers but accessible to us via protected mechanisms. | Yes |
This API extracts information from NIB document of indonesia
\nThis API extracts information from Izin Usaha document of indonesia
\nThis API extracts information from SKK document of indonesia
\n|
\n","urlObject":{"protocol":"https","path":["v3","tasks","sync","extract","id_document"],"host":["eve","idfy","com"],"query":[],"variable":[]}},"response":[{"id":"2c94eb4d-163c-476a-98c2-126de2df0a30","name":"Success: SKK","originalRequest":{"method":"POST","header":[{"key":"account-id","value":"{{account-id}}","type":"text"},{"key":"api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"task_id\": \"cabb04c4-ff90-4978-85d3-bca03b98c1e1\",\n \"group_id\": \"8f705d41-313e-48a0-83ee-6f54dbf84c0a\",\n \"data\": {\n \"document1\": \"This API extracts information from an NPWP document of Indonesia
\nThis API extracts details from an SSM document (Malaysia).
\nThis API extracts details from MyKad ID (Malaysia).
\nThis API extracts details from a trade license (UAE)
\nThis API extracts details from a utility bill of an entity/ individual based in UAE
\nOur generic OCR API is designed to effortlessly extract key value pairs from any document, enabling businesses to streamline their document processing workflow and increase productivity. Our goal is to empower our customers with the ability to extract critical data from documents in seconds, eliminating the need for manual data entry and reducing errors.
\n| Key | Type | Details | Mandatory | |
|---|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes | |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes | |
data | Object with the below parameters | The details of the data required to perform the task. | Yes | |
document1 | string | image in base64 format OR URL of the image of PAN card (front) | Yes | |
doc_type | string | Document type to be mentioned. All supported document type mentioned below | Yes |
**For information on additional supported document types or to request custom document configurations, please contact eve.support@idfy.com.
\nThis endpoint is used to perform real-time validation checks on the ID document submitted by a user. These checks are best suited for the following use-cases
\nTo give the user an immediate feedback in case a wrong or unexpected document is submitted:
\nYou need to call this API by using the requestid while making a call to this Get Task API.
\nThis endpoint is used to perform real-time validation checks on the ID document submitted by a user. These checks are best suited for the following use-cases
\nTo give the user an immediate feedback in case a wrong or unexpected document is submitted:
\nYou need to call this API by using the requestid while making a call to this Get Task API.
\nThis endpoint is used to perform real-time validation checks on the ID document submitted by a user. These checks are best suited for the following use-cases
\nTo give the user an immediate feedback in case a wrong or unexpected document is submitted:
\nThis endpoint is used to perform real-time validation checks on the ID document submitted by a user. These checks are best suited for the following use-cases
\nTo give the user an immediate feedback in case a wrong or unexpected document is submitted:
\nAn advanced Machine learning based solution that helps you identify the type of document that is being sent by the user.
\n","_postman_id":"393ed7ad-ba1e-4971-af83-c905dda40c96"},{"name":"Document Masking","item":[{"name":"Async","item":[{"name":"Aadhaar Masking","item":[{"name":"ind_aadhaar masking async","id":"dfc27903-e302-4570-b3f6-ee55e907bc92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"},{"key":"api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"data\": {\n \"document1\": \"URL / Base64\",\n \"consent\": \"yes\",\n \"m*****r\": true,\n \"m*****s\": true,\n \"l*****s\": true\n }\n}"},"url":"https://eve.idfy.com/v3/tasks/async/mask/ind_aadhaar","description":"This endpoint allows you to mask the first 8 digits of Aadhaar number on an Aadhaar card image or a PDF. It returns the image/PDF with masked Aadhaar number in real-time.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | string/base64 | URL to document or image in base64 format | Yes |
data.consent | boolean | \"yes\" or \"no\" | Yes |
data.m\\*r | boolean | Option to mask qr code \\* contact IDfy sales SPOC for exact key name | No |
data.m\\*s | boolean | Option to mask all digits on aadhaar card \\* contact IDfy sales SPOC for exact key name | No |
data.l\\*s | boolean | Option to extract last four digits of aadhaar number \\* contact IDfy sales SPOC for exact key name | No |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid while making a call to this Get Task API.
\nMost standard Aadhaar masking solutions are limited to masking individual Aadhaar card images. Using this endpoint you will be able to locate any hidden Aadhaar cards within stacks of files, folders, or multipage documents, and mask all of them.
\nMaskingPro takes a multipage pdf or a zip file as input, and returns the same file as output, except that all its Aadhaar cards within are masked.
\n5 minute video explainer on how it works
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
file1 | URL to document or PDF or ZIP | Yes | |
action | string | This will be \"mask\" for masking action | yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
file_type | string | type of the file which was given as input |
output_file | String - URL | The output file of masking document |
total_elements_masked | string | Total number of pages that had aadhaar number and is masked. |
total_elements_present | string | Total number of elements present in the document. |
unprocessed_element | string | total number of elements that was not masked because it was non-aadhaars |
unprocessed_file | string | URL of the CSV file with the names of the documents that are not masked because it was non-aadhaars. |
This endpoint allows you to mask the first 8 digits of Aadhaar number on an Aadhaar card image or a PDF. It returns the image/PDF with masked Aadhaar number in real-time.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | string/base64 | URL to document or image in base64 format | Yes |
data.consent | boolean | \"yes\" or \"no\" | Yes |
data.m\\*r | boolean | Option to mask qr code \\* contact IDfy sales SPOC for exact key name | No |
data.m\\*s | boolean | Option to mask all digits on aadhaar card \\* contact IDfy sales SPOC for exact key name | No |
data.l\\*s | boolean | Option to extract last four digits of aadhaar number \\* contact IDfy sales SPOC for exact key name | No |
Allows you to specifically mask a few elements on a documents.
\n","_postman_id":"0a34f706-7e39-4100-a1ae-7f46b39a1e3c"},{"name":"Document Correction","item":[{"name":"Sync","item":[{"name":"compress image sync","id":"bd450e2d-1a7c-488b-b3f7-8970496f744e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"task_id\":\"1111-58fc-4ba4-ab20-5bc8e7c3c41e\",\r\n\"group_id\":\"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\r\n\"data\":{\r\n\"document1\":\"https://cdn.zeebiz.com/hindi/sites/default/files/2021/11/21/70604-surrender-another-pan-card.jpg\",\r\n\"compression_by\":\"percentage\",\r\n\"compress_to\":\"50\"\r\n}\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.idfy.com/v3/tasks/sync/compress/image","description":"This API helps in compressing the image by a given percentage or size limit before it is passed to any other IDfy's API for extraction.
\nThis API checks for any sign of tampering on the Indian PAN card.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | string | PAN Card image in URL or base64 format | Yes |
IDfy's ID Forgery Detection is designed to detect any form of forgery or tampering in ID documents, providing a robust defense against fraud. Our solution helps you catch fraudulent activities at the source while ensuring your legitimate customers enjoy a seamless and efficient experience.
\nPAN tampering API allows you to be confident that the PAN card supplied to you hasn’t been built using a fake PAN generator app, doesn’t have a passport photo pasted on it, and has all the expected color schemes that a standard PAN is expected to have.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.document1 | string | PAN Card image in URL or base64 format | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis endpoint is used to perform real-time validation checks and OCR on the ID document submitted by a user.
\nYou need to call this API by using the requestid while making a call to this Get Task API.
\nThe solutions under this bucket will allow you to:
\nOur automated DL verification API is used to verify Indian Driving license details with government databases. We will provide output from any one of the sources, depending on the source availability. You will receive the following information (based on the source) -
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
id_number | string | Driving License Number | Yes |
date_of_birth | string | Date of birth, in \"yyyy-mm-dd\" format | Yes |
state_info | boolean | returns state of the user when true | No |
age_info | boolean | returns if the user is minor or not | No |
| Source | Details |
|---|---|
Sarthi | [ dl_status, dl_number, date_of_issue, date_of_last_transaction, last_transacted_at nt_validity_from nt_validity_to, t_validity_from, t_validity_to, hazardous_valid_till, hill_valid_till, cov_details, badge_details ] |
Madhya Pradesh Transport | [date_of_issue, nt_validity_to, t_validity_to, cov_details, badge_details, relatives_name, name, address, issuing_rto_name, city, card_serial_no ] |
Kerala Transport | [cov_details, relatives_name, name, gender, address ] |
Andhra Pradesh Transport | [nt_validity_to, t_validity_to, cov_details, issuing_rto_name] |
Chhattisgarh Transport | [date_of_issue, nt_validity_to, t_validity_to, cov_details, badge_details, relatives_name, name, address, issuing_rto_name] |
Telangana Transport | [nt_validity_to, t_validity_to, cov_details, issuing_rto_name] |
Key | Type | Details |
request_id | String | request ID |
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API helps you fetch the Digilocker-verified documents for your customers, based on his/her consent. The document retrieved will be in xml file format. It can extract user’s aadhaar, pan, or both documents.
\nEnd users need not have a Digilocker account in advance to fetch the documents. If an individual does not have a Digilocker account, we will create an account on the go and fetch the documents. Experience for both types of customers will be exactly the same.
\nThis is a one-time setup activity performed by IDfy. To use this API you need the secret_key & the key_id, please reach out to eve.support@idfy.com for activating this service and getting access to the required details. Please note the 'secret_key' is to be passed in an encoded form, use the base 64 encoder for this.
\nTo integrate with this API and fetch documents from Digilocker you just need to make a single API call to fetch a particular document.
\nEvery document needs different input parameters for searching and downloading. For example, a Pan card needs a Pan number and full name. Currently this API supports Aadhaar & PAN.
\nOnce you redirect the customers to the redirect_url, they should be prompted for the Digilocker sign-up/sign-in page, and then on successful sign-in, we will fetch the relevant docs and send the success/failure response over callback_url provided in the request body.
\nOn completion of the task, this API sends the response over a callback_url passed in the request body.
\nThis API can also handle multiple document fetch for Aadhaar and PAN as part of one single Digilocker journey. As part of the input we need to pass both the doc_type and also pass the PAN details in the extra_field section. Post the Digilocker journey is complete we get one single response with both the document details on the webhook. For the sample request body please refer to Success: Multidoc fetch example.
\n“key_id”, “ou_id”, and “secret” must be of the same combination as shared by IDfy.
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API can be used to verify both Individual/company PAN (Indian Tax ID) from the government database.
\nKey | Type | Details |
request_id | String | request ID |
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis async API helps to fetch the requestid in the response.
\nThe requestid is used to fetch the user's details by making a call to the Get Task API.
\nBoth Individual/company PAN (Indian Tax ID) can be verified from the government database. We also provide the name match result in case you provide a name in the request.
\n","_postman_id":"4c1b6892-4735-45fa-8202-d122dd8b3d16"},{"name":"ind_voter_id","item":[{"name":"ind_voter_id async","id":"ad5c4f51-f5f6-4b7b-a2d6-ae54d0cc9369","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{api-key}}","type":"text"},{"key":"api-key","value":"{{account-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\n \"task_id\": \"74f4c926-250c-43ca-9c43-453e87ceacd1\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab10-5bc8e7c3c41e\",\n \"data\": \n\n {\n \"id_number\": \"Get Indian Voter ID details verified from the National Voter Service Portal (NVSP). We also provide the name match result in case you provide a name in the request.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.id_number | string | Voter ID Number | Yes |
data.name_on_card | string | Name on Voter ID (for name matching) | No |
Key | Type | Details |
request_id | String | request ID |
You need to call this API by using the requestid while making a call to this Get Task API.
\nThis API allows you to verify the Passport details of a user from the originating Source website.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.passport_file_number | string | Passport file number | Yes |
data.date_of_birth | string | Date of birth of person | No |
Key | Type | Details |
request_id | String | request ID |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nNCVT Certificate is a certificate awarded for the completion of ITI courses under the purview of the NCVT. The full form of NCVT is the National Council of Vocational Training. Exams conducted by the NCVT include Craftsman Training Scheme (CTS), Apprentice Training Scheme (ATS), and All India Trade Test (AITT).
\nNCVT certificate verification API helps corporate companies to check and verify if the end-user has completed the NCVT exams like CTS, ATS, AITT
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.e_certificate_number | string | The E-certificate number provided to you | Yes |
data.certificate_type | string | Type of certificate: NCVT / Apprenticeship | Yes |
Key | Type | Details |
request_id | String | request ID |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nICWAI/ICMAI Verify API is used to check if the member is verified to be part of ICWAI (Cost Accountants)
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
| task_id | string | The unique identifier of a requested task provided by you. | Yes |
| group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
| data | Object with below parameters | The details of the data required to perform the task. | Yes |
| membership_number | string | ICMAI membership number | Yes |
| Key | Type | Details |
| source_output | object | Output received from the source |
| status | string | \"id_found\", \"id_not_found\", \"source_down\" |
| icmai_membership_number | string | ICMAI membership number/ |
| icmai_member_name | string | ICMAI member name |
| icmai_category | string | ICMAI category |
| string | ||
| qualification | string | Qualification |
| cop_holder | string | COP holder |
| member_status | string | Member status |
| removal_reason | string | Removal reason |
This API allows the client to verify the integrity and validity of a medical certificate
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.registration_no | string | Registration number | Yes |
data.year_of_registration | string | Year of registration | Yes |
data.council_name | string | Medical council name | Yes |
Key | Type | Details |
request_id | String | request ID |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nICSI Verify API is used to check if the member is verified to be part of ICSI (Company Secretary)
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.icsi_member_number | string | ICSI membership number | Yes |
icsi_member_type | string | ICSI membership type: \"ACS\" or \"FCS\" | Yes |
Key | Type | Details |
request_id | String | request ID |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\n{{response.message}}
","This API returns if a particular phone number has been tagged with a cybercrime request.
\nKey | Type | Details |
request_id | String | request ID |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nNurse verification is used to verify whether an individual is a registered nurse with the Indian Nurse Council (INC).
\n| Key | Type | Details |
|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. |
data | Object with below parameters | The details of the data required to perform the task. |
data.nuid_number | string | Nurse Unique Identification Number |
Key | Type | Details |
request_id | String | request ID |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nThe PAN-Aadhaar linkage API allows you to validate if a PAN and an Aadhaar number are linked.
\nKey | Type | Details |
request_id | String | request ID |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nIncome Tax Return (ITR) Analysis API will give the visibility of the borrower’s financial know-how whether it’s an individual’s income or a company’s financial transactions, in real-time.
\nThis API captures the income tax returns of the borrower based on the login credentials from ITR 1 - 7 with simple, single API integration.
\nITR Analysis can be done through 4 methods:
\nusing user name and password
\nretrieving ITR details from the portal and uploading the PDF
\nretrieving ITR details through the ITR Acknowledgement file
\nretrieving ITR details through the ITR XML/JSON file. To upload the XML file, add it to the \"file\" key in the request body and include the \"tag,\" which can be found on the ITR portal, to complete the analysis
\nKey | Type | Details |
request_id | String | request ID |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nKey | Type | Details |
request_id | String | request ID |
Key | Type | Details |
request_id | String | request ID |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\n26AS is a consolidated tax statement that contains all the tax-related information of an individual or entity, including details of tax deducted at source (TDS), tax collected at source (TCS), advance tax, and more. It is maintained by the Income Tax Department of India and is useful in various financial transactions, including the loan lending journey
\nThis API generates 26as analysis. There are two methods that can be used for this -
1. Fetch using username password
2. Fetch using PDF file
\n","_postman_id":"b0b32568-c95c-4640-8f50-bb21d907702e"},{"name":"ind_validate_bank_account","item":[{"name":"ind_validate_bank_account async","id":"2f04ee3f-fec2-4aa5-98f9-e97491216115","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"task_id\": \"123\",\n \"group_id\": \"1234\",\n \"data\": {\n \"bank_account_no\": \"1234123412341234\",\n \"bank_ifsc_code\": \"ABCD12341234\",\n \"nf_verification\": false //optional\n }\n}"},"url":"https://eve.idfy.com/v3/tasks/async/verify_with_source/validate_bank_account","description":"This API enables you to verify the bank account of a user. There are two methods to do the same: penny-drop and penny-less.
\nThe financial (penny drop) or non-financial (penny less) approach for bank validation depends on the following key in request body.
\nnf_verification= false (for penny drop)
\nnf_verification= true (for penny less)
\nKey | Type | Details |
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nThis API allows you to verify whether the user’s mobile number is present in the mobile number revocation list.
\nKey | Type | Details |
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nThis section contains all the checks that are relevant from an individual's perspective.
\n","_postman_id":"f370dbcc-822f-428c-a5b1-985ace6ec31c"},{"name":"Merchants","item":[{"name":"Async","item":[{"name":"ind_gst_certificate","item":[{"name":"ind_gst_certificate verify async","id":"767902a5-2783-4455-9a7f-1970fa869b82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"},{"key":"api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"data\": \n {\n \"gstin\": \"26AAQCS4259Q1ZC\",\n \"filing_details\": true, //Could be true or false\n \"e_invoice_details\":true //Could be true or false\n }\n}\n"},"url":"https://eve.idfy.com/v3/tasks/async/verify_with_source/ind_gst_certificate","description":"Get GST details using the GSTIN.
\n| Type | Details | |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nGet company details using CIN or Company name from the MCA database.
\nThis API can verify if merchants are registered with the Registrar of Companies, and are registered with the same details as expected.
\n| Type | Details | |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nIDfy’s Udyog Aadhaar API allows you to verify details of Udyog Aadhaar (also known as Aadhaar for Business). Clients want to validate that the Udyog Aadhaar certificates that their customers have sent to them are valid, due to the following reasons:
\nWith the udyog aadhaar verification API, we aim to provide our clients a mechanism to verify merchant’s Udyog aadhaar numbers from the udyog aadhaar govt source. The API accepts a UAM number and responses with details about the Name of the Business, Major activity, category type, expiration date, address, NIC, etc.
\n| Type | Details | |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nIDfy’s Udyam Aadhaar API allows you to verify details of Udyam Aadhaar (also known as Aadhaar for Business). In 2020, the GOI deprecated the Udyog Aadhaar and instructed all the 1.05 Cr merchants who had registered on Udyog to migrate to Udyam. While the migration has been slow, Udyam Aadhaar is likely to see high usage in the near future. Clients want to validate that the Udyam Aadhaar certificates that their customers have sent to them are valid, due to the following reasons:
\nWith the Udyam aadhaar verification API, we aim to provide our clients a mechanism to verify merchant’s Udyam aadhaar numbers from the Udyam aadhaar govt source. The API accepts a UAM number and responses with details about the Name of the Business, Major activity, category type, expiration date, address, NIC, etc.
\n| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
The Importer -Exporter Code (IEC) is a key business identification number which is mandatory for Exports or Imports. No person shall make any import or export except under an IEC Number granted by the DGFT. In case of import or export of services or technology, the IEC shall be required only when the service or technology provider is taking benefits under the Foreign Trade Policy or is dealing with specified services or technologies.
\nIDfy’s IEC / ROC API allows you to verify the IEC Number of the importer / exporter
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.import_export_code | string | Import export code | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nIBBI or Insolvency and Bankruptcy Board of India was established on 1st October, 2016 under the Insolvency and Bankruptcy Code, 2016 (Code). It is a key pillar that is responsible for implementation of the Code that consolidates and amends the laws relating to reorganization and insolvency resolution of corporate persons, partnership firms and individuals in a time bound manner. IDfy’s IBBI Verification API will enable you to understand if the corporation is under bankruptcy.
\n| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nThis API accepts the FSSAI Registration number as an input and in return verifies if the certificate exists, and verifies the company and Product related details.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.registration_no | string | The FBO (Food Business operators) registration number | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nThis API accepts the FSSAI Registration number as an input and in return provides the PDF document.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
task_id | string | The unique identifier of a requested task provided by you. | Yes |
group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
data | Object with below parameters | The details of the data required to perform the task. | Yes |
data.registration_no | string | The FBO (Food Business operators) registration number | Yes |
| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nAllows you to verify if a company is currently ongoing or has in the past, gone through NCLT Proceedings.
\n| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nThis API that takes the establishment code / establishment name as an input and returns the relevant information about the establishment.
\n| Key | Type | Details | Mandatory |
|---|---|---|---|
| task_id | string | The unique identifier of a requested task provided by you. | Yes |
| group_id | string | The unique identifier of a group of tasks. A group_id is generally used to group different tasks for one profile. The group_id can also be used to fetch results for multiple tasks together. The group_id is also provided by you. | Yes |
| data | Object with below parameters | The details of the data required to perform the task. | Yes |
| establishment_name | string | Establishment name | Yes |
| establishment_code_number | string | Establishment code number | Yes |
| Key | Type | Details |
| source_output | object | Output received from the source |
| status | string | \"id_found\", \"id_not_found\", \"source_down\" |
| details | object | |
| establishment_name | string | Establishment name |
| date_of_establishment_setup | string | Date of establishment setup (YYYY-MM-DD) |
| establishment_code | string | Establishment code |
| working_status | string | Working status - \"live_establishment/CLOSED/ALL MEMBER EXCLUDED/CODE NO ALLOTTED WAS AFTER ONLINE REGISTRATION STARTED.\" |
| date_of_coverage | string | Date of coverage |
| last_updated_on_epfo | string | Last updated on EPFO |
| business_activity | string | Business activity |
| pan_status | string | PAN status |
| ownership_type | string | Ownership type |
| address | string | Address |
| pin_code | string | PIN code |
| city | string | City |
| district | string | District |
| state | string | State |
| country | string | Country |
| epfo_office_name | string | EPFO office name |
The ESIC Verify API helps to verify whether the employers & employees are registered or not in the ESIC scheme
\n| Key | Type | Details |
|---|---|---|
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nThis API searches the database for shop certificate verification for every state and returns the valid information.
\nHaryana
\nDelhi
\nTamilNadu
\nGujarat
\nKerala
\nTelangana
\nRajasthan
\nKey | Type | Details |
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nHaryana
\nDelhi
\nTamilNadu
\nGujarat
\nKerala
\nTelangana
\nRajasthan
\n","urlObject":{"protocol":"https","path":["v3","tasks"],"host":["eve","idfy","com"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}],"variable":[]}},"response":[{"id":"1903699b-a86b-499c-bf91-fb707ee351f7","name":"Err: Invalid Request ID","originalRequest":{"method":"GET","header":[{"key":"api-key","type":"text","value":"{{api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"},{"key":"account-id","type":"text","value":"{{account-id}}"}],"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99l","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99l"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"content-length","value":"45"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"date","value":"Mon, 07 Nov 2022 19:01:26 GMT"},{"key":"server","value":"idfy"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The requested id does not exist\"\n}"},{"id":"9aaa6540-fbcd-4032-a4b5-d626d1630d3c","name":"Err: Invalid Authentication","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"1232","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"3211","type":"text"}],"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99l","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99l"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"content-length","value":"48"},{"key":"x-idfy-gateway-id","value":"eve-gateway"},{"key":"date","value":"Mon, 07 Nov 2022 19:02:02 GMT"},{"key":"server","value":"idfy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid authentication credentials\"\n}"},{"id":"65828e57-6aba-4b7c-af2d-d8a9fb2f45f5","name":"Err: Missing API Key","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"}],"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99l","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99l"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"content-length","value":"41"},{"key":"x-idfy-gateway-id","value":"eve-gateway"},{"key":"date","value":"Mon, 07 Nov 2022 19:02:24 GMT"},{"key":"server","value":"idfy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"No API key found in request\"\n}"},{"id":"f330d66d-01f4-43a7-9479-7800fa06b722","name":"haryana","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"48"},{"key":"x-idfy-gateway-id","value":"eve-gateway"},{"key":"date","value":"Tue, 27 Aug 2024 12:28:34 GMT"},{"key":"server","value":"idfy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n{\n \"action\": \"verify_with_source\",\n \"completed_at\": \"2021-08-01T22:38:08+05:30\",\n \"created_at\": \"2021-08-01T22:38:05+05:30\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"request_id\": \"54ad20c5-aaff-420a-8180-cd43eae23a2e\",\n \"result\": {\n \"source_output\": {\n \"status\": \"id_found\",\n \"details\": {\n \"shop_id\": \"1815\",\n \"shop_name\": \"M/s Bobby Sweet House\",\n \"address\": {\n \"street\": \"Near Paper Mill Gate, Jagadhri Road\",\n \"town\": \"Yamunanagar\",\n \"tehsil\": \"Jagadhri\",\n \"district\": \"Yamunanagar\"\n },\n \"area_of_circle\": \"Ajit Singh (LI-Y.Ngr-I)\",\n \"submission_date\": \"yyyy-mm-dd\",\n \"certificate_status\": \"Approved\",\n \"certificate_validity\": \"2013\"\n }\n },\n \"status\": \"completed\",\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"type\": \"ind_shop_license\"\n }\n}\n]"},{"id":"cd44a718-4c92-4905-9b9a-c1bd7717cd8c","name":"delhi","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"48"},{"key":"x-idfy-gateway-id","value":"eve-gateway"},{"key":"date","value":"Tue, 27 Aug 2024 12:28:34 GMT"},{"key":"server","value":"idfy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n{\n \"action\": \"verify_with_source\",\n \"completed_at\": \"2021-08-01T22:38:08+05:30\",\n \"created_at\": \"2021-08-01T22:38:05+05:30\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"request_id\": \"54ad20c5-aaff-420a-8180-cd43eae23a2e\",\n \"result\": {\n \"source_output\": {\n \"status\": \"id_found\", //\"id_not_found\", \"source_down\",\n \"details\": {\n \"registration_no\": \"2011046135\",\n \"registration_date\": \"22/12/2011\"\n \"shop_name\": \"Nonu Singh Sweets\",\n \"category\": \"Commercial Establishment\",\n \"date_of_commencement\": \"22-12-2011\"\n \"address\": {\n \"house_number\": \"86/4 Gurgaon Delhi\",\n \"pin\": \"122001\",\n \"contact_number\": \"67878723\",\n \"fax\":\" \",\n }\n \"email\":\"\",\n \"website\":\"\",\n \"occupier\":\"Titu Singh\",\n \"occupiers_father\":\"S/o Nami Singh\",\n \"manager\":\"Ravi Prasad\",\n \"managers_father\":\"S/o Ravinder Prasad\",\n \"nature\":\"Sweets Shop\",\n \"male_workers\":\"1\",\n \"female_workers\":\"0\",\n \"young_workers\":\"0\",\n \"total_workers\":\"1\",\n \"family_workers\":\"0\",\n \"confidential_employees\":\"0\",\n \"certificate_no\":\"2011046135\",\n \"certificate_date\":\"22-12-2011\",\n }\n }\n },\n \"status\": \"completed\",\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"type\": \"ind_shop_license\"\n}\n]"},{"id":"0a20a222-22fd-47d7-b270-2aabe51cc729","name":"tamil_nadu","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"48"},{"key":"x-idfy-gateway-id","value":"eve-gateway"},{"key":"date","value":"Tue, 27 Aug 2024 12:28:34 GMT"},{"key":"server","value":"idfy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"action\": \"verify_with_source\",\n \"completed_at\": \"2021-08-01T22:38:08+05:30\",\n \"created_at\": \"2021-08-01T22:38:05+05:30\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"request_id\": \"54ad20c5-aaff-420a-8180-cd43eae23a2e\",\n \"result\": {\n \"source_output\": {\n \"status\": \"id_found\",\n \"business_name\": \"Kumaran Sweets\",\n \"address\": \"19/3Gandhiji street, Erode ward no.24 Town, Erode Taluk, Erode District, Tamil Nadu, 638001\",\n \"owner_name\": \"RAMACHANDRAN K\",\n \"expiry_date\": \"2023-12-31\",\n \"certificate_status\": \"Appove\",\n \"act_name\": \"Tamilnadu catering establishment rules, 1959\"\n }\n },\n \"status\": \"completed\",\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"type\": \"ind_shop_license\"\n }\n]"},{"id":"f5697acc-ee3d-4eba-b815-dfdcea269ed5","name":"gujarat","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"48"},{"key":"x-idfy-gateway-id","value":"eve-gateway"},{"key":"date","value":"Tue, 27 Aug 2024 12:28:34 GMT"},{"key":"server","value":"idfy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"action\": \"verify_with_source\",\n \"completed_at\": \"2021-08-01T22:38:08+05:30\",\n \"created_at\": \"2021-08-01T22:38:05+05:30\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"request_id\": \"54ad20c5-aaff-420a-8180-cd43eae23a2e\",\n \"result\": {\n \"source_output\": {\n \"status\": \"id_found\", //\"id_not_found\", \"source_down\",\n \"business_name\": \"\",\n \"certificate_status\": \"\",\n \"previous_certificate_status\": \"\",\n \"act_name\": \"\"\n }\n },\n \"status\": \"completed\",\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"type\": \"ind_shop_license\"\n }\n\n]"},{"id":"13d27ba4-c91c-4193-a0e0-4fd1e09e02fd","name":"kerala","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"48"},{"key":"x-idfy-gateway-id","value":"eve-gateway"},{"key":"date","value":"Tue, 27 Aug 2024 12:28:34 GMT"},{"key":"server","value":"idfy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"action\": \"verify_with_source\",\n \"completed_at\": \"2024-07-11T13:58:56+05:30\",\n \"created_at\": \"2024-07-11T13:58:55+05:30\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"request_id\": \"3f229979-4968-4fbd-8d86-ba04941eb902\",\n \"result\": {\n \"source_output\": {\n \"details\": {\n \"address\": \"Vyttila ,P B NO 1951, DOOR NO 29/940A, VYTTILA, COCHIN - 682019\",\n \"business_name\": \"SCIENTIFIC ENTERPRISES\",\n \"certificate_status\": \"Approved\",\n \"employer_name\": \"P.N.BALASUBRAMANIAN ,\",\n \"number_of_employee\": \"7\"\n },\n \"status\": \"id_found\"\n }\n },\n \"status\": \"completed\",\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"type\": \"ind_shop_license\"\n }\n]"},{"id":"50ff93d2-edec-454f-820c-fe54dd8cc3f4","name":"telangana","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"48"},{"key":"x-idfy-gateway-id","value":"eve-gateway"},{"key":"date","value":"Tue, 27 Aug 2024 12:28:34 GMT"},{"key":"server","value":"idfy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"action\": \"verify_with_source\",\n \"completed_at\": \"2021-08-01T22:38:08+05:30\",\n \"created_at\": \"2021-08-01T22:38:05+05:30\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"request_id\": \"54ad20c5-aaff-420a-8180-cd43eae23a2e\",\n \"result\": {\n \"source_output\": {\n \"status\": \"id_found\", //\"id_not_found\", \"source_down\",\n \"business_name\": \"\",\n \"certificate_status\": \"\",\n \"previous_certificate_status\": \"\",\n \"address\": \"SAROJA DAIRY,H NO 8-3-275/11/1RAMCHANDRAPUR COLONY, H NO 8-3- 275/11/1 RAMCHANDRAPUR COLONY, WARD NO.13, WARD NO.13,KARIMNAGAR\",\n \"act_name\": \"\",\n \"owner_name\": \"MANDALA SAROJA\",\n \"certificate\": \"\",\n \"expiry_date\": \"2023-01-01\"\n }\n },\n \"status\": \"completed\",\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"type\": \"ind_shop_license\"\n }\n]"},{"id":"761ca82b-881e-4898-8919-0db31464564d","name":"rajasthan","originalRequest":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://eve.idfy.com/v3/tasks?request_id=f375b6b3-80bf-40f6-92cb-50276e849d99","protocol":"https","host":["eve","idfy","com"],"path":["v3","tasks"],"query":[{"key":"request_id","value":"f375b6b3-80bf-40f6-92cb-50276e849d99"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"48"},{"key":"x-idfy-gateway-id","value":"eve-gateway"},{"key":"date","value":"Tue, 27 Aug 2024 12:28:34 GMT"},{"key":"server","value":"idfy"},{"key":"Via","value":"1.1 google"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"action\": \"verify_with_source\",\n \"completed_at\": \"2024-07-11T14:07:16+05:30\",\n \"created_at\": \"2024-07-11T14:07:10+05:30\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"request_id\": \"dac61882-8679-488b-8b23-dbecbc7d2efb\",\n \"result\": {\n \"source_output\": {\n \"details\": {\n \"act_name\": \"The Shops and Commercial Establishments Act, 1958\",\n \"address\": \"147, BAAJDARON KI MORI, CHANDI KI TAKSAL, JAIPUR,Jaipur, Rajasthan\",\n \"business_name\": \"JAI SHIV GURUJI TRANSPORT\",\n \"certificate\": \"https://storage.idfy.com/shop_est_certificates_rj/certificate_dac61882-8679-488b-8b23-dbecbc7d2efb.pdf?Expires=1720773439&GoogleAccessId=api-gateway-prod%40idfy-1338.iam.gserviceaccount.com&Signature=W1qaD0UM5edq8aVsdhIq0EFad%2BCFE%2B2UJVvCXTAof95X6QNb%2F%2BnUb7MJXaI98ccjaJQ5zDzchkzq7rB6ZbqWRmStRFhmrt7OSUzL7MbNENbEipPcnxy90PEQ3LzvBgyDaqmOFnxIddxy70dPAaoIwI%2F7H089duqMCu%2BC225BeaecJwhaTmc5ed9sg1Z9urkj%2F4v4S6PcXK5%2FxotlJuG%2FSZL%2BtWdiDtVymVvIKiPLW204%2Fei8AGRFi%2BlA%2FxhX%2Fromc3KzkySuP9qHn268eZFKp0FdQrodNe66iaO9776Voj3MekvZ1zK%2Fl5aTTC1DKbc1u0rty3tXB9cag%2Ftvl15o0w%3D%3D\",\n \"certificate_status\": \"Valid\",\n \"owner_name\": \"Rajeev Maru\",\n \"valid_upto\": \"2023-12-31\"\n },\n \"status\": \"id_found\"\n }\n },\n \"status\": \"completed\",\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"type\": \"ind_shop_license\"\n }\n]"}],"_postman_id":"7548cd1c-928d-422d-8620-c98c4d795f4f"}],"id":"a10fbb2b-81ea-4011-9e41-cceda49a6bfe","_postman_id":"a10fbb2b-81ea-4011-9e41-cceda49a6bfe","description":""},{"name":"pan_gst link","item":[{"name":"pan_gst_link","id":"16b6a0a6-328a-457f-86bd-41627e2e3a78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"default"},{"key":"account-id","value":"{{account-id}}","type":"default"}],"body":{"mode":"raw","raw":"{\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"data\": {\n \"pan_number\": \"This API accepts a PAN number as an input and returns a list of GST numbers linked to that specific PAN number.
\nKey | Type | Details |
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nThis async API verifies a given TIN number from government database.
\nKey | Type | Details |
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nGSTR Analysis API captures and analyzes the raw data available on the GSTN server and gives you detailed, intuitive insights from a defined period on the various sale & purchase transactions to the lender. This tool not just captures the sales and purchase data of the borrower, but also the defected, returned products, routine transactions, etc., or in general the transaction trends (Business v/s In-house) giving you the complete 360-degree view of the borrower.
\nIn this step, the OTP is generated and shared on the registered mobile number.
\nKey | Type | Details |
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nGSTR Analysis API captures and analyzes the raw data available on the GSTN server and gives you detailed, intuitive insights from a defined period on the various sale & purchase transactions to the lender. This tool not just captures the sales and purchase data of the borrower, but also the defected, returned products, routine transactions, etc., or in general the transaction trends (Business v/s In-house) giving you the complete 360-degree view of the borrower.
\nTo verify the OTP with limited time validity
\nKey | Type | Details |
request_id | string | UUID for your request. Use this ID to fetch the results of your task. Refer \"Fetch Task Results\" section.\" |
You need to call this API by using the requestid obtained in the accompanying POST response call.
\nThis section contains all the checks that are relevant from a merchant's perspective.
\n","_postman_id":"67258afd-99f7-4104-aa1c-d8dea907f50d"},{"name":"Asset","item":[{"name":"Async","item":[{"name":"ind_rc_basic","item":[{"name":"ind_rc_basic async","id":"fc01ccde-62f4-481b-97ae-d08cc5a19661","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"account-id","value":"{{account-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"task_id\": \"74f4c926-250c-43ca-9c53-453e87ceacd1\",\n \"group_id\": \"8e16424a-58fc-4ba4-ab20-5bc8e7c3c41e\",\n \"data\": {\n \"rc_number\": \"DL8XXXXX54\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://eve.idfy.com/v3/tasks/async/verify_with_source/ind_rc_basic","description":"This API is used to verify Vehicle Registration Certificate (RC) number against Vahan vehicle database. The API allows you to -
\nThe API also provides the option to match the name of vehicle owner that has been captured in a use-case against the name of vehicle owner on the database
\nKey |