{"info":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","description":"

IDfy's Background Verification API solution is a set of APIs that can be used to initiate and get results of background verification on candidates - employees / delivery partners / contract workers etc... depending on the business use case of your company.

\n

This documentation will help you understand:

\n\n

Setting up your account

\n

To run our APIs, you need an api-key and an account-id. If you don’t have these yet, please get in touch with your SPOC at IDfy for us to create an account for you. Once your account is created, you can start testing and using our APIs in 3 simple steps:

\n\n

IDfy's BGV API Solutions

\n

IDfy provides two API integration flows for background verification process:

\n

1. Profile Creation

\n

This is when you or your partnered HRMS/ATS/OnboardingTool is collecting the information form the candidates and you need to push the information to IDfy to start the BGV.

\n\n\n

2. Profile Invite

\n

This is when you or your partnered HRMS/ATS/OnboardingTool is not collecting the information from the candidate and you want IDfy to collect the information required for BGV.

\n\n\n

Getting Started with API

\n

To get started, you will need 3 details from IDfy:

\n
    \n
  1. company_id: This is your company identifer for testing. Will be provided by IDfy team and sent as company_id in request body of payload.
    2. \n
  2. apikey: This is a passkey. It will be provided by IDfy team and sent as apikey in request headers.
    3. \n
\n

Note: Accepted file formats for all the documents we accept are image, word, excel or pdf.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"17769389","collectionId":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","publishedId":"UVREmQyR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-01-03T12:14:16.000Z"},"item":[{"name":"Profile Creation Flow V2","item":[{"name":"API","item":[{"name":"Profile Create","id":"c62d01d0-2c30-4f0c-a3b8-0f0da4310858","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{api-key}}","type":"default"}],"body":{"mode":"raw","raw":"{\n \"group_id\": \"ba688d35-1d29-4ade-847d-a913315fd07c\",\n \"profile_data\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"phone\": \"9898989898\",\n \"fathers_name\":\"Jack Doe\",\n \"company_id\": \"b7b88179-d8f7-4884-b3d7-c9d63ecdc2fe\",\n \"date_of_birth\":\"31-01-1992\",\n \"apackage_public_id\": \"b16e6c83-048e-4a42-ae50-bfe914e18653\",\n \"band\": \"B2\",\n \"employee_id\": \"11280401\",\n \"doc_urls\" : [ \n { \n \"label\": \"loa\",\n \"url\": \"public url of pdf to be added here\"\n }\n ]\n },\n \"tasks\": [\n {\n \"type\": \"address_verification\",\n \"task_id\": \"c8946770-667e-4093-835e-44328533916c\",\n \"data\": {\n \"address_type\": \"Permanent\",\n \"street_address\": \"13-B Gulmohar Society\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharashtra\",\n \"country\": \"India\",\n \"pin\": \"400054 \",\n \"landmark\": \"Juhu Circle\",\n \"residence_type\": \"own\",\n \"period_of_stay_from\": \"23-03-1993\",\n \"period_of_stay_to\": \"24-08-2018\",\n \"landline_no\": \"9879877999\"\n }\n },\n {\n \"type\": \"pan_verification\",\n \"task_id\": \"c8ac3757-f656-410a-bddd-369e4b2ddb81\",\n \"data\": {\n \"pan_number\": \"DEDPT1234A\",\n \"pan_name\": \"John Doe\"\n }\n },\n {\n \"type\": \"voter_verification\",\n \"task_id\": \"5bfbbeb2-fbe0-4ddc-ad5b-6385fbd32be8\",\n \"data\": {\n \"voter_name\": \"John Doe\",\n \"voter_number\": \"ZMQ2696600\"\n }\n },\n {\n \"type\": \"court_record_verification\",\n \"task_id\": \"0d0fa0b5-f0be-40a9-afa0-25726d6b0da5\",\n \"data\": {\n \"cr_dob\": \"13-12-1990\",\n \"cr_fathers_name\": \"James Doe\",\n \"cr_address_type\": \"Permanent\",\n \"cr_address\": \"13-B Gulmohar Society, Juhu, Mumbai, Maharashtra, India, 400054\"\n }\n },\n {\n \"type\": \"database_verification\",\n \"task_id\": \"azef6578-c06e-3094-a4cd-d75ecaa3a6h2\",\n \"data\": {\n \"db_dob\": \"13-12-1990\",\n \"db_fathers_name\": \"James Doe\",\n \"db_address_type\": \"Permanent\",\n \"db_address\": \"13-B Gulmohar Society, Juhu, Mumbai, Maharashtra, India, 400054\"\n }\n },\n {\n \"type\": \"pcc_verification\",\n \"task_id\": \"1230987677\",\n \"data\": {\n \"pcc_address_type\": \"Permanent\",\n \"pcc_address\": \"Skyline Icon\",\n \"pcc_city\": \"Mumbai\",\n \"pcc_state\": \"Maharashtra\",\n \"pcc_country\": \"India\",\n \"pcc_pin\": \"400072\",\n \"pcc_landmark\": \"kurla road\",\n \"pcc_phone\": \"9999999999\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dc.idfy.com/v2/profiles","description":"

Submit verification requests

\n

You can submit a profile with a set of verification tasks by making a POST call to the endpoint https://api.dc.idfy.com/v2/profiles

\n

Each profile will be unique for each candidate. You need to maintian and send a group_id for each candidate profile. This group_id will be uniquely linked to one candidate profile.

\n

You can submit multiple verification tasks (such as court_verification, employment_verification, etc.) for a single candidates (profile) in the same API request.

\n

While submitting a task, you must also compulsorily provide a unique task_id for each task. This task_id must be unique for all your tasks irrespective of profiles. task_id once sent cannot be used in the same or any other profile.

\n

This task_id will be used to asynchronously push the status back to specifically update status of that task mapped to task_id.

\n

In a candidate profile, you can append multiple tasks in multiple instances using different task_id under a single group_id. Note that you cannot use a previously sent task_id as it will thrown an error.

\n

Request attributes

\n

Profile Object Attributes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
namestringYesName of the CandidateJohn Doe
emailstringYesEmail ID of the candidatejohn@doe.com
phonestringYesPhone Number of the candidate
(10 digits format without country code)		9898989898
date_of_birthstringYesRequired for Court and Police verification. Required format is \"dd-mm-yyyy\" for all dates.13-12-1990
fathers_namestringYesRequired for Court and Police verificationJames Doe
company_idstringYesUnique company ID. It is provided by IDfy5a9f6578-c06e-4212-a4cd-d75ecaa3a8a8
package_public_idstringNoThe ID of the package that needs to be applied to the profile. To be used if the billing is based on package; not alacarte.fbc11cd7-6c5a-4f6e-ad39-7d526622cda3
employee_idstringNoUnique employee ID11280401
bandstringNoBand / Grade type of employee that needs to be applied to the profileB2
tasksArrayYesArray of tasks requesting for verification [task_object1, task_object2][ {\"type\":\"pan_verification\" , ... } , {\"type\":\"reference_verification\" , ... } ]
doc_urls and put \"loa\" as labelArray of one objectYesCandidate Letter of Authorization\"doc_urls\" : [
{
\"label\": \"loa\",
\"url\": \"
}
public_url_of_loa ]
\n

Task Object Attributes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
typestringYesRequested task type. See table below for different task typesreference_verification
group_iduuidNoA unique ID for grouping tasks (generally used to group tasks for a profile).Emp_1_BGVCheck
task_iduuidYesEach task has a unique ID that is used to identify it.Emp_1_address_verification
dataObjectYesDetails for requested verification. It varies based on the Task Type. Refer Task Types tab to check data object required for each task typedata_for_requested_card
\n

Task types

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
pan_verificationVerifying Pan data
driving_license_verificationVerifying Driving License data
voter_verificationVerifying Voter data
passport_verificationVerifying Passport data
experience_verificationVerifying Experience data
qualification_verificationVerifying Qualification data
address_verificationVerifying Address data
reference_verificationVerifying Reference data
court_record_verificationVerifying Court Record data
police_verificationVerifying Police Record data
database_verificationVerifying Database data
directorshipVerifying Directorship data
credit_history_verificationVerifying Credit History data
social_media_verificationVerifying Social Media data
\n
","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","profiles"],"host":["api","dc","idfy","com"],"query":[],"variable":[]}},"response":[{"id":"df3a4bca-0fb4-495b-bbd2-3ca28be7a4bf","name":"Create Profile Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"apikey","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group_id\": \"ba688d35-1d29-4ade-847d-a913315fd07c\",\n \"profile_data\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"phone\": \"9898989898\",\n \"company_id\": \"5a9f6578-c06e-4212-a4cd-d75ecaa3a8a8\",\n \"package_public_id\": \"fbc11cd7-6c5a-4f6e-ad39-7d526622cda3\",\n \"fathers_name\":\"Jack Doe\",\n \"date_of_birth\":\"31-01-1992\",\n \"band\": \"B2\",\n \"employee_id\": \"11280401\",\n \"doc_urls\" : [ \n { \n \"label\": \"loa\",\n \"url\": \"public_url_of_loa\"\n }\n ]\n }\n },\n \"tasks\": [\n {\n \"type\": \"experience_verification\",\n \"task_id\": \"6a9f6578-c06e-4313-a4cd-d75ecaa3a9d9\",\n \"data\": {\n \"name_of_organization\": \"Infosys\",\n \"employee_id\": \"2312321\",\n \"designation\": \"SDE\",\n \"department\": \"Tech\",\n \"date_of_joining\": \"23-05-2014\",\n \"currently_working\": \"Yes\",\n \"last_working_date\": \"27-06-2017\",\n \"resigned\": \"No\",\n \"organization_street_address\": \"4F Rushabh Chambers\",\n \"organization_city\": \"Mumbai\",\n \"organization_state\": \"Maharashtra\",\n \"organization_country\": \"India\",\n \"organization_pin_code\": \"400058\",\n \"salary_type\": \"Monthly\",\n \"salary\": \"25000\",\n \"salary_currency\": \"INR\",\n \"supervisor_name\": \"Tom Clarke\",\n \"supervisor_designation\": \"Manager\",\n \"supervisor_email\": \"manager@infosys.com\",\n \"supervisor_phone\": \"9898989898\",\n \"reason_for_leaving\": \"\",\n \"doc_urls\": [\n {\n \"label\": \"Salary Slip\",\n \"url\": \"https://www.example.com/sal_slip.jpeg\"\n },\n {\n \"label\": \"Offer letter\",\n \"url\": \"https://www.example.com/offer_letter.jpeg\"\n }\n ]\n }\n },\n {\n \"type\": \"qualification_verification\",\n \"task_id\": \"6a9f6578-c06e-4213-a4cd-d75ecaa3a9d0\",\n \"data\": {\n \"degree_name\": \"B.Tech\",\n \"specialization_or_major\": \"Computer Science\",\n \"institute\": \"IIT\",\n \"certifying_authority\": \"IIT\",\n \"roll_number\": \"25254\",\n \"grade\": \"First\",\n \"course_started_on\": \"12-12-2010\",\n \"course_completed_on\": \"14-06-2014\",\n \"institute_street_address\": \"abcd\",\n \"institute_city\": \"Mumbai\",\n \"institute_state\": \"Maharashtra\",\n \"institute_country\": \"India\",\n \"institute_pin_code\": \"466600\",\n \"course_type\": \"Regular\",\n \"doc_urls\": [\n {\n \"label\": \"Marksheet\",\n \"url\": \"https://www.example.com/mark_sheet1.jpeg\"\n },\n {\n \"label\": \"Degree Certificate\",\n \"url\": \"https://www.example.com/degree_certi1.jpeg\"\n }\n ]\n }\n },\n {\n \"type\": \"address_verification\",\n \"task_id\": \"6a9f6578-c06e-5343-a4cd-d75ecaa3a7d9\",\n \"data\": {\n \"address_type\": \"Permanent\",\n \"street_address\": \"303 A dawd\",\n \"city\": \"Mumbai\",\n \"state\": \"Maharashtra\",\n \"country\": \"India\",\n \"pin\": \"400660\",\n \"landmark\": \"Nat park\",\n \"residence_type\": \"own\",\n \"period_of_stay_from\": \"23-03-1993\",\n \"period_of_stay_to\": \"24-08-2016\",\n \"landline_no\": \"9879877999\"\n }\n },\n {\n \"type\": \"reference_verification\",\n \"task_id\": \"6a9f6578-c06e-4940-a4cd-d75ecaa3a0d5\",\n \"data\": {\n \"name_of_referee\": \"Ravi Kumar\",\n \"relationship_with_candidate\": \"Supervisor\",\n \"referee_organization\": \"Infosys\",\n \"referee_designation\": \"Supervisor\",\n \"referee_contact_number\": \"9898989887\",\n \"referee_email_address\": \"refer@infosys.com\"\n }\n },\n {\n \"type\": \"pan_verification\",\n \"task_id\": \"6a9f6578-c06e-6713-a4cd-d75ecaa3a3d4\",\n \"data\": {\n \"pan_number\": \"123456789123\",\n \"pan_name\": \"ABC\"\n }\n },\n {\n \"type\": \"passport_verification\",\n \"task_id\": \"6a9f6578-c06e-1209-a4cd-d75ecaa3a2d4\",\n \"data\": {\n \"passport_no\": \"1234567890\",\n \"passport_name\": \"XYZ\",\n \"passport_doe\": \"1991-03-31\",\n \"passport_issuing_country\": \"India\",\n \"doc_urls\": [\n {\n \"label\": \"First page of passport\",\n \"url\": \"https://www.example.com/passport_front.jpeg\"\n },\n {\n \"label\": \"Last page of passport\",\n \"url\": \"https://www.example.com/passport_back.jpeg\"\n }\n ]\n }\n },\n {\n \"type\": \"voter_verification\",\n \"task_id\": \"6a9f6578-c06e-4355-a4cd-d75ecaa3a4g9\",\n \"data\": {\n \"voter_name\": \"John Doe\",\n \"voter_number\": \"FB272DE\"\n }\n },\n {\n \"type\": \"court_record_verification\",\n \"task_id\": \"6a9f6578-c06e-2305-a4cd-d75ecaa3a7h3\",\n \"data\": {\n \"cr_dob\": \"13-30-1990\",\n \"cr_fathers_name\": \"Don\",\n \"cr_husband_name\": \"David\",\n \"cr_address_type\": \"Permanent\",\n \"cr_address\": \"303 A, dawd, Mumbai, Maharashtra, India, 400660\"\n }\n },\n {\n \"type\": \"database_verification\",\n \"task_id\": \"6a9f6578-c06e-3094-a4cd-d75ecaa3a6h2\",\n \"data\": {\n \"db_dob\": \"13-30-1990\",\n \"db_fathers_name\": \"Don\",\n \"db_address_type\": \"Permanent\",\n \"db_address\": \"303 A, dawd, Mumbai, Maharashtra, India, 400660\"\n }\n },\n {\n \"type\": \"pcc\",\n \"task_id\": \"9a9f6578-c06e-3094-a4cd-d75ecaa3b6h2\",\n \"data\": {\n \"name\": \"John Doe\",\n \"phone\": \"9821456676\",\n \"region\": \"thane_city\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dc.idfy.com/v2/profiles"},"status":"Accepted","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n request_id: \"4f99-asd-4f99-fT1234-qwer2\",\n error: \"\"\n}"}],"_postman_id":"c62d01d0-2c30-4f0c-a3b8-0f0da4310858"},{"name":"Request ID - Profile Create","id":"2d82ace9-248d-4da1-aab9-74f3401b1fc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{api-key}}","type":"text"}],"url":"https://api.dc.idfy.com/v2/profiles?request_id={{request_id}}","description":"

Webhook - Profile creation status

\n\"Flow%20design%20end%20to%20end%20for%203%20states%20after%20POST\"\n\n

Since the IDfy's Profile Creation Flow operate in an asynchronous manner, you can pre-register a webhook URL with us. Whenever a profile creation request (POST request) is submitted, the status (successful/error) will be sent to the registered webhook.

\n

Success

\n

On successful profile creation (POST request), the JSON body for webhook will be the same as the GET response. Please refer the Profile Examples Tab to view the JSON body.

\n

Error

\n

In case of profile creation (POST request) failure, the JSON body will contain the request_ID and the error message. Example JSON body:

\n
{\"request_id\": \"abcnmam-asdad-dpakmadl-asdmk\",\n\"error\":\"Tasks with the same task ids already exist - [snfnskj-sdsdnc06e-1s01-a4csdnd-d75ecsfmwa3a2d4, snfsl-c0sdfkm6e-23b5-jsfk-d75ecskfnaa3a7h3]\"\n}\n\n
\n

More error message examples:

\n\n

Processing

\n

In case of profile creation (POST request) still processing state, the JSON body will contain the request_ID and the specific error message. Example JSON body:

\n
{\"request_id\": \"abcnmam-asdad-dpakmadl-asdmk\",\n\"error\":\"Your request in progress\"\n}\n\n
\n

Profile States

\n\n\n

Webhook - Task and profile completion

\n

We support 2 types of webhooks:

\n
    \n

  1. Profile completion callback

    \n
    2. \n

  2. Task completion callback

    \n
    3. \n
\n

Both, for now will be configured on the same webhook URL.

\n

You can pre-register a webhook URL with us. Whenever a task is completed, or the complete profile verification is completed, we would POST the result on this webhook

\n

The JSON body for webhook will be the same as the GET response. The webhook can only support basic authentication with username and password. Please refer the Profile Examples Tab to view the JSON body.

\n

Subsequent GET or webhook calls can include following information -

\n\n
{\n    \"group_id\": \"Group_id62359\",\n    \"profile_data\": {\n        \"company_id\": \"123456-070f-4d91-abf0-6eb8203880fa\",    \n        \"status\": \"green\",\n        \"request_id\": \"4a2bc27d-231d-48c7-9685-697a0edcd4fb\",\n        \"created_at\": \"2024-03-28T11:02:24+05:30\",\n        \"completed_at\": \"2024-03-28T11:38:54+05:30\",\n        \"tat\": 1      \n    },\n    \"tasks\": [\n        {\n            \"type\": \"credit_history_verification\",\n            \"task_id\": \"5c3e3af5-e6fb-47d8-b741-5d8d67df88d547584\",\n            \"status\": \"green\",\n            \"created_at\": \"2024-03-28T11:03:45+05:30\",\n            \"completed_at\": \"2024-03-28T11:17:07+05:30\",\n            \"tat\": 1,\n            \"reason\": \"\"\n        },\n        {\n            \"type\": \"qualification_verification\",\n            \"task_id\": \"5c3e3af5-e6fb-47d8-b741-5d8d67df88d5\",\n            \"status\": \"green\",\n            \"created_at\": \"2024-03-28T11:02:24+05:30\",\n            \"completed_at\": \"2024-03-28T11:22:16+05:30\",\n            \"tat\": 1,\n            \"reason\": \"\"\n        },\n        {\n            \"type\": \"experience_verification\",\n            \"task_id\": \"e7831c31-5457-43d0-9194-0db028617a12\",\n            \"status\": \"green\",\n            \"created_at\": \"2024-03-28T11:02:24+05:30\",\n            \"completed_at\": \"2024-03-28T11:23:32+05:30\",\n            \"tat\": 1,\n            \"reason\": \"\"\n        },\n        {\n            \"type\": \"address_verification\",\n            \"task_id\": \"c59ee41f-ed3d-4db7-a42e-7a01958f5584\",\n            \"status\": \"green\",\n            \"created_at\": \"2024-03-28T11:02:24+05:30\",\n            \"completed_at\": \"2024-03-28T11:25:13+05:30\",\n            \"tat\": 1,\n            \"reason\": \"\"\n        },\n        {\n            \"type\": \"police_verification\",\n            \"task_id\": \"f36c545b-bf72-47e6-8faa-a7a530c6305d\",\n            \"status\": \"green\",\n            \"created_at\": \"2024-03-28T11:02:24+05:30\",\n            \"completed_at\": \"2024-03-28T11:30:57+05:30\",\n            \"tat\": 1,\n            \"reason\": \"\"\n        },\n        {\n            \"type\": \"reference_verification\",\n            \"task_id\": \"821e9121-6e42-4cf4-b5c2-cb44d396e513\",\n            \"status\": \"green\",\n            \"created_at\": \"2024-03-28T11:02:24+05:30\",\n            \"completed_at\": \"2024-03-28T11:38:49+05:30\",\n            \"tat\": 1,\n            \"reason\": \"\"\n        }\n    ],\n    \"pdf_report\": \"https://idfy.com/pdf/sample.pdf\"\n}\n\n
\n

Applicable Statuses and Trigger Points

\n
    \n

  1. awaiting_input

    \n
    2. \n

  2. in_progress

    \n
    3. \n

  3. insufficiency

    \n
    4. \n

  4. red

    \n
    5. \n

  5. amber

    \n
    6. \n

  6. green

    \n
    7. \n

  7. grey

    \n
    8. \n

  8. red(interim)

    \n
    9. \n

  9. amber(interim)

    \n
    10. \n

  10. canceled

    \n
    11. \n
\n

Such statuses are triggered real time as and when updates happen in IDfy BGV system.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","profiles"],"host":["api","dc","idfy","com"],"query":[{"key":"request_id","value":"{{request_id}}"}],"variable":[]}},"response":[{"id":"3c653acb-51e0-4d20-a5f7-496c4e6fe70c","name":"GET Request ID - Profile Create","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"{{api-key}}","type":"text"}],"url":{"raw":"https://api.dc.idfy.com/v2/profiles?request_id={{request_id}}","protocol":"https","host":["api","dc","idfy","com"],"path":["v2","profiles"],"query":[{"key":"request_id","value":"{{request_id}}"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"group_id\": \"Group_id62359\",\n \"profile_data\": {\n \"company_id\": \"123456-070f-4d91-abf0-6eb8203880fa\", \n \"status\": \"green\",\n \"request_id\": \"4a2bc27d-231d-48c7-9685-697a0edcd4fb\",\n \"created_at\": \"2024-03-28T11:02:24+05:30\",\n \"completed_at\": \"2024-03-28T11:38:54+05:30\",\n \"tat\": 1 \n },\n \"tasks\": [\n {\n \"type\": \"credit_history_verification\",\n \"task_id\": \"5c3e3af5-e6fb-47d8-b741-5d8d67df88d547584\",\n \"status\": \"green\",\n \"created_at\": \"2024-03-28T11:03:45+05:30\",\n \"completed_at\": \"2024-03-28T11:17:07+05:30\",\n \"tat\": 1,\n \"reason\": \"\"\n },\n {\n \"type\": \"qualification_verification\",\n \"task_id\": \"5c3e3af5-e6fb-47d8-b741-5d8d67df88d5\",\n \"status\": \"green\",\n \"created_at\": \"2024-03-28T11:02:24+05:30\",\n \"completed_at\": \"2024-03-28T11:22:16+05:30\",\n \"tat\": 1,\n \"reason\": \"\"\n },\n {\n \"type\": \"experience_verification\",\n \"task_id\": \"e7831c31-5457-43d0-9194-0db028617a12\",\n \"status\": \"green\",\n \"created_at\": \"2024-03-28T11:02:24+05:30\",\n \"completed_at\": \"2024-03-28T11:23:32+05:30\",\n \"tat\": 1,\n \"reason\": \"\"\n },\n {\n \"type\": \"address_verification\",\n \"task_id\": \"c59ee41f-ed3d-4db7-a42e-7a01958f5584\",\n \"status\": \"green\",\n \"created_at\": \"2024-03-28T11:02:24+05:30\",\n \"completed_at\": \"2024-03-28T11:25:13+05:30\",\n \"tat\": 1,\n \"reason\": \"\"\n },\n {\n \"type\": \"police_verification\",\n \"task_id\": \"f36c545b-bf72-47e6-8faa-a7a530c6305d\",\n \"status\": \"green\",\n \"created_at\": \"2024-03-28T11:02:24+05:30\",\n \"completed_at\": \"2024-03-28T11:30:57+05:30\",\n \"tat\": 1,\n \"reason\": \"\"\n },\n {\n \"type\": \"reference_verification\",\n \"task_id\": \"821e9121-6e42-4cf4-b5c2-cb44d396e513\",\n \"status\": \"green\",\n \"created_at\": \"2024-03-28T11:02:24+05:30\",\n \"completed_at\": \"2024-03-28T11:38:49+05:30\",\n \"tat\": 1,\n \"reason\": \"\"\n }\n ],\n \"pdf_report\": \"https://idfy.com/pdf/sample.pdf\"\n}"}],"_postman_id":"2d82ace9-248d-4da1-aab9-74f3401b1fc7"}],"id":"6cf26b5c-e081-4cbd-bce7-b381af3a56d3","description":"

This section talks about two APIs that are used to push data to IDfy (like candidate details) via POST call, and pull data from IDfy (like task status, or profile report) via GET call or configuring your webhook.

\n","_postman_id":"6cf26b5c-e081-4cbd-bce7-b381af3a56d3","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"Profile Updation","item":[],"id":"86669739-32c9-44b3-9756-7a97917d4a59","description":"
Add verification tasks to a Profile
\n

We directly do not support the HTTP PUT method, but one of our Task Object attirbute, the Group Id can be exploited to serve a similar function

\n
    \n

  • Use same group_id for all tasks belonging to a particular profile

    \n
    • \n

  • To add new verification tasks to an already exisiting profile, pass the same group_id with the new task.

    \n
    • \n

  • Before making second API request to add new verification tasks to an already exisiting profile via previous API request, wait for the 'successful' webhook callback of previouly sent API request.

    \n
    • \n

  • Please make there is a timelag of more than 1 minute between 2 POST requests for same group_id to avoid race conditions at IDfy end.

    \n
    • \n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CaseGroup IDTask IDsBehaviorError
Case 1newnewprofile and task created
Case 2newrepeatedprofile created without taskTask id already exists
Case 3newnew, repeatedprofile and new task created,repeated task not created
Case 4repeatednewtask created in exiting profile
Case 5repeatedrepeatedprofile not created, task not created
Case 6repeatednew, repeatednew task created in exiting profile, repeated tasks are not added
\n
","_postman_id":"86669739-32c9-44b3-9756-7a97917d4a59","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"Task Types","item":[{"name":"pan_verification","item":[],"id":"2f1c9062-abf9-4bc4-9ed3-18bba6fa082b","description":"

Request Submission Object

\n
    \n
  • Data object
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    AttributesTypeMandatoryDescriptionExample
    pan_numberstringYesPermanent Account NumberDEDPT1234A
    pan_namestringYesPAN NameJohn Doe
    doc_urlsarrayNoArray of labeled document URLs[{\"label\": \"Front side of PAN Card\", \"url\":\"https://www.example.com/pan_front.jpeg\"}]
    \n
    • \n
\n","_postman_id":"2f1c9062-abf9-4bc4-9ed3-18bba6fa082b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"driving_license_verification","item":[],"id":"d3cd6a77-e721-4b34-ba79-3c3347ed4649","description":"

Request Submission Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
driving_license_numberstringYesDriving License NumberACFDF3454I
driving_license_namestringYesName as on Driving LicenseJohn Doe
statestringYesState of issueMaharashtra
date_of_birthstringYesDate of Birth01-01-1990
doc_urlsarrayNoArray of labeled document URLs[{\"label\": \"Front of Driving license\", \"url\":\"https://www.example.com/dl_front.jpeg\"}, {\"label\": \"Back of Driving License\", \"url\":\"[https://www.example.com/dl_back.jpeg\"}\\]\\](https://www.example.com/dl_back.jpeg)
\n
","_postman_id":"d3cd6a77-e721-4b34-ba79-3c3347ed4649","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"voter_verification","item":[],"id":"2fc54eac-4e8b-489f-a0aa-ed03737a1ea3","description":"

Request Submission Object

\n\n","_postman_id":"2fc54eac-4e8b-489f-a0aa-ed03737a1ea3","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"aadhaar_verification","item":[],"id":"c2759c27-7bde-4162-ac94-35cb5c5a5187","description":"

Request Submission Object

\n
    \n
  • Data Object
    • \n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
aadhaar_numberstringYesAadhaar NumberXXXXXXXX0799
aadhaar_namestringYesFull NameJohn Doe
aadhaar_yobstringYesYear of Birth1998
aadhaar_genderstringYesMale, Female, OtherMale
\n
","_postman_id":"c2759c27-7bde-4162-ac94-35cb5c5a5187","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"uan_check_verification","item":[],"id":"84dccfbd-3859-4d55-ba52-8269ccb7dc95","description":"

Request Submission Object

\n
    \n
  • Data Object / this is moonlighting check
    • \n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
uan_numberstringYesUniversal Account NumberXXXXXXXX0799
\n
","_postman_id":"84dccfbd-3859-4d55-ba52-8269ccb7dc95","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"passport_verification","item":[],"id":"0a5d2427-b3b1-456a-9828-4afd998f95c1","description":"

Request Submission Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
passport_nostringYesPassport NumberDEDPT1234A
passport_namestringYesPassport NameJohn Doe
passport_doestringYesDate of Birth31-01-1992
passport_issuing_countrystringYesIssuing CountryIndia
doc_urlsarrayYesArray of labeled document URLs[{\"label\": \"Front Page of Passport\", \"url\":\"https://www.example.com/pass_frontpage.jpeg\"}, {\"label\": \"Last Page of Passport\", \"url\":\"https://www.example.com/pass_lastpage.jpeg\"}]
\n
","_postman_id":"0a5d2427-b3b1-456a-9828-4afd998f95c1","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"experience_verification","item":[],"id":"afaae16e-bfae-4585-afd5-d0763003549b","description":"

Request Submission Object

\n
    \n
  • Data Object
    • \n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
name_of_organizationstringYesFull Name of OrganizationInfosys
employee_idstringYesEmployee ID2312321
designationstringYesEmployee's DesignationSoftware Developer
departmentstringNoDepartmentTechnology
date_of_joiningstringYesDate of Joining (format DD-MM-YYYY)27-06-2015
currently_workingstringYesCurrently working here? [\"Yes\", \"No\"]Yes
last_working_datestringYesLast Working Date (format DD-MM-YYYY) (If currently working is Yes, then you must share the expected last working date; in any case 'last_working_date' cannot be blank)27-06-2017
resignedstringNoHave you resigned? [\"Yes\", \"No\"]No
organization_street_addressstringYesStreet address of organization85-C, Mittal Tower, Nariman Point
organization_citystringYescityMumbai
organization_statestringYesstateMaharashtra
organization_countrystringYescountryIndia
organization_pin_codestringYespin code400021
salary_typestringNoSalary Type [\"Per Annum\", \"Monthly\", \"Weekly\", \"Hourly\"]Monthly
salarystringNoSalary (CTC) (Please enter only numbers)45000
salary_currencystringNoSalary Currency [\"INR\", \"USD\", \"EUR\", \"AUD\", \"GBP\", \"JPY\", \"Other\"]INR
supervisor_namestringYesName of Immediate SupervisorTom Clarke
supervisor_designationstringYesDesignation of Immediate SupervisorManager
supervisor_emailstringYesEmail Address of Immediate Supervisormanager@infosys.com
supervisor_phonestringYesContact Number for Immediate Supervisor9898989899
reason_for_leavingstringNoReason(s) For LeavingNA
doc_urlsarrayNoArray of labeled document URLs
skip_documentstringNoSkip adding document [\"Yes\", \"No\"][{\"label\": \"Salary Slip\", \"url\":\"https://www.example.com/sal_slip.jpeg\"}, {\"label\": \"Offer Letter\", \"url\":\"[https://www.example.com/offer_letter.jpeg\"}]](https://www.example.com/offer_letter.jpeg%22%7D%5D)
skip_document_reasonstringNoReason for not adding documents.No
\n
","_postman_id":"afaae16e-bfae-4585-afd5-d0763003549b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"qualification_verification","item":[],"id":"5c60fe4d-f382-4587-89ea-2feb43c810be","description":"

Request Submission Object

\n
    \n
  • Data object
    • \n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
degree_namestringYesDegree Name [\"Bachelors\", \"Masters\", \"10th\", \"12th\", \"Ph. D\", \"Post Doc\", \"Professional\", \"Diploma\", \"Certificate\"]B.Tech
specialization_or_majorstringYesSpecialization / MajorComputer Science
institutestringYesInstitute nameIIT - Bombay
certifying_authoritystringYesCertifying AuthorityUGC
roll_numberstringYesRoll Number / Registration Number / Final Exam Seat Number25254
gradestringNoGrade/CGPA/Percentage/Final MarksFirst Class
course_started_onstringNoFrom12-08-2010
course_completed_onstringYesCourse Completed On14-06-2014
institute_street_addressstringNostreet address of instituteMain Gate Rd, IIT Area, Powai
institute_citystringNoCityMumbai
institute_statestringNoStateMaharashtra
institute_countrystringNoCountryIndia
institute_pin_codestringNoPin code400076
course_typestringNoCourse type [\"Regular\", \"Distance Education\"]Regular
doc_urlsarrayNoArray of labeled document URLs[{\"label\": \"Marksheet\", \"url\":\"https://www.example.com/mark_sheet.jpeg\"}, {\"label\": \"Degree Certificate\", \"url\":\"[https://www.example.com/degree_certi.jpeg\"}]](https://www.example.com/degree_certi.jpeg)
skip_documentstringNoSkip adding document [\"Yes\", \"No\"]No
skip_document_reasonstringNoReason for not adding documents.
\n
","_postman_id":"5c60fe4d-f382-4587-89ea-2feb43c810be","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"address_verification","item":[],"id":"987b4b7e-2ae7-4fa3-8730-b0cf8f1dd272","description":"

Request Submission Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
address_typestringYesType of Address [\"Current\", \"Permanent\", \"Past\"]Permanent
street_addressstringYesStreet Address13-B Gulmohar Society, Juhu
citystringYesCityMumbai
statestringYesStateMaharashtra
countrystringYesCountryIndia
pinstringYesPin code400054
landmarkstringNoLandmarkJuhu Circle
residence_typestringNoResidence Type, ex: [\"own\", \"rented\", \"other\"]own
period_of_stay_fromstringNoPeriod of Stay From Date (format DD-MM-YYYY)23-03-1993
period_of_stay_tostringNoPeriod of Stay To Date (format DD-MM-YYYY)24-08-2018
landline_nostringYesLandline Number
(10 digits only format)		9898989898
refereestringNoName and relationship of referee with candidateJosh Joy, Friend
doc_urlsarrayNo (required for past addressess)Array of labeled document URLs[{\"label\": \"Address Proof 1\", \"url\":\"https://www.example.com/electricty_bill.jpeg\"}, {\"label\": \"Address Proof 2\", \"url\":\"https://www.example.com/dl_back.jpeg\"}\\]
\n
","_postman_id":"987b4b7e-2ae7-4fa3-8730-b0cf8f1dd272","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"reference_verification","item":[],"id":"4582180a-6d3f-4800-9879-372ad5190388","description":"

Request Submission Object

\n
    \n
  • Data object
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    AttributesTypeMandatoryDescriptionExample
    name_of_refereestringYesName of RefereeTom Clarke
    relationship_with_candidatestringYesRelationship with CandidateManager
    referee_organizationstringNoCurrent Organization of RefereeInfosys
    referee_designationstringNoCurrent Designation of RefereeVice President
    referee_contact_numberstringYesContact Number of Referee9898989899
    referee_email_addressstringYesEmail Address of Refereevp@infosys.com
    candidate_organization_same_as_refereestringYesIs the candidate currently employed with the organization where the referee worksNo
    referee_reporting_managerstringYesIs the the referee candidate's reporting manager?Yes
    \n
    • \n
\n","_postman_id":"4582180a-6d3f-4800-9879-372ad5190388","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"court_record_verification","item":[],"id":"3e2d03d2-56d1-42f5-9871-078622f79b60","description":"

Request Submission Object

\n
    \n
  • Data object
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    AttributesTypeMandatoryDescriptionExample
    cr_dobstringYesDate of birth13-12-1990
    cr_fathers_namestringYesFather's NameJames Doe
    cr_husband_namestringNoHusband's Name (if applicable)
    cr_address_typestringYesType of Address [\"Current\", \"Permanent\", \"Past\"]Permanent
    cr_addressstringYesComplete Address13-B Gulmohar Society, Juhu, Mumbai, Maharashtra, India, 400054
    \n
    • \n
\n","_postman_id":"3e2d03d2-56d1-42f5-9871-078622f79b60","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"efir_verification","item":[],"id":"b8c9c79a-3c1f-4df6-bd50-c9f3f14e1d26","description":"

Request Submission Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
efir_dobstringYesDate of birth13-12-1990
efir_fathers_namestringYesFather's NameJames Doe
efir_address_typestringYesType of Address [\"Current\", \"Permanent\"]Permanent
efir_addressstringYesComplete Address13-B Gulmohar Society, Juhu, Mumbai, Maharashtra, India, 400054
\n
","_postman_id":"b8c9c79a-3c1f-4df6-bd50-c9f3f14e1d26","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"police_verification","item":[],"id":"a42cd5ab-85ae-4a7f-88b2-a031d970a870","description":"

Request Submission Object

\n
    \n
  • Data object
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    AttributesTypeMandatoryDescriptionExample
    police_verification_address_typestringYesType of Address [\"Current\", \"Permanent\"]Permanent
    police_verification_namestringYesName of the candidateJohn Doe
    police_verification_fathers_namestringYesFather's NameJames Doe
    police_verification_addressstringYesComplete Address13-B Gulmohar Society, Juhu, Mumbai, Maharashtra, India, 400054
    police_verification_date_of_birthstringYesDate of birth13-12-1990
    \n
    • \n
\n","_postman_id":"a42cd5ab-85ae-4a7f-88b2-a031d970a870","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"pcc (Police Clearance Certificate)","item":[],"id":"abff50dc-775a-4e7d-ac75-55f87b97e7f4","description":"

Request Submission Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
namestringYesName of the candidateJohn Doe
phonestringYesPhone number of the candidate9898989898
regionstring
doc_urlsarrayYesArray of labeled document URLs[{\"label\": \"ID proof 1\", \"url\":\"https://www.example.com/pan_card.jpeg\"}, {\"label\": \"Photo\", \"url\":\"https://www.example.com/profile_picture.jpeg\"}\\]
\n

PCC documents

\n
    \n
  • ID proof (PAN or DL image)
    • \n
  • Current Address Proof
    • \n
  • Company Demand Letter (LOA)
    • \n
  • Photo of the candidate
    • \n
  • Signature (optional)
    • \n
\n","_postman_id":"abff50dc-775a-4e7d-ac75-55f87b97e7f4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"database_verification","item":[],"id":"b126cea6-9e89-4f49-a5f9-c1111b649924","description":"

Request Submission Object

\n
    \n

  • Data object

    \n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    AttributesTypeMandatoryDescriptionExample
    db_dobstringYesDate of birth13-30-1990
    db_fathers_namestringYesFather's NameJames Doe
    db_address_typearrayYesType of Address [\"Current\", \"Permanent\", \"Past\"]Permanent
    db_addressstringYesComplete Address13-B Gulmohar Society, Juhu, Mumbai, Maharashtra, India, 400660
    \n
    • \n
\n","_postman_id":"b126cea6-9e89-4f49-a5f9-c1111b649924","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"pos_verification","item":[],"id":"37e858d3-4d42-4c4c-bc02-588a89c187b4","description":"

Request Submission Object

\n
    \n
  • Data object
    • \n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
pos_dobstringYesDate of birth13-30-1990
pos_fathers_namestringYesFather's NameJames Doe
pos_address_typearrayYesType of Address [\"Current\", \"Permanent\", \"Past\"]Permanent
pos_addressstringYesComplete Address13-B Gulmohar Society, Juhu, Mumbai, Maharashtra, India, 400660
\n
","_postman_id":"37e858d3-4d42-4c4c-bc02-588a89c187b4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"directorship_verification","item":[],"id":"ebc46d1b-02fe-4c49-bb7a-b7d7f79c3a11","description":"

Request Submission Object

\n
    \n
  • Data object
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    AttributesTypeMandatoryDescriptionExample
    dis_dinstringYesDIN Number34567890
    \n
    • \n
\n","_postman_id":"ebc46d1b-02fe-4c49-bb7a-b7d7f79c3a11","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"credit_history_verification","item":[],"id":"d405de8f-831a-44f1-be75-d2ef0bac8df0","description":"

Request Submission Object

\n
    \n

  • Data object

    \n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    AttributesTypeMandatoryDescriptionExample
    ch_dobstringYesDate of Birth1990-01-01
    ch_genstringNoGenderMale
    ch_atypestringYesAddress Category [\"Residence\", \"Permanent\", \"Office\", \"Not Categorized\"]Permanent
    ch_addstringYesStreet Address13-B Gulmohar Society, Juhu, Mumbai, Maharashtra, India, 400660
    ch_citystringYesCityMumbai
    ch_statestringYesStateMaharashtra
    ch_pinstringYesPIN Code400059
    ch_constringYesCountryIndia
    ch_panstringYesPan Card NumberDEDPT1234A
    ch_phstringYesPhone Number9997460680
    doc_urlsarrayNoArray of labeled document URLs[{\"label\": \"Address Proof 1\", \"url\":\"https://www.example.com/electricty_bill.jpeg\"}, {\"label\": \"Pan Card\", \"url\":\"https://www.example.com/pan.jpeg\"}]
    \n
    • \n
\n","_postman_id":"d405de8f-831a-44f1-be75-d2ef0bac8df0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"social_media_verification","item":[],"id":"8d88ef61-85cf-4773-a6f6-9b95447cbc0b","description":"

Request Submission Object

\n
    \n

  • Data object

    \n
    \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    AttributesTypeMandatoryDescriptionExample
    sm_namestringYesNameJohn Doe
    sm_pmailstringYesPrimary EmailJohn@doe.com
    sm_smailstringNoSecondary EmailJohn1@doe.com
    sm_pnostringYesPrimary Phone Number9997460680
    sm_snostringNoSecondary Phone Number9988776655
    sm_dobstringYesDate of birth13-30-1990
    sm_genstringYesGenderMale
    sm_empstringYesCurrent employmentInfosys
    sm_desgstringYesCurrent designationSoftware Developer
    sm_edustringYesHighest EducationM.Tech
    sm_atypestringYesType of Address [\"Current\", \"Permanent\"]Permanent
    sm_fnamestringYesFathers full nameJohn
    sm_mnamestringYesMothers full nameJamie
    doc_urlsarrayYesArray of labeled document URLs[{\"label\": \"Recent Photograph (6 Months)\", \"url\":\"https://www.example.com/photo.jpeg\"}, {\"label\": \"Resume\", \"url\":\"[https://www.example.com/resume.jpeg\"}]](https://www.example.com/resume.jpeg)
    \n
    • \n
\n","_postman_id":"8d88ef61-85cf-4773-a6f6-9b95447cbc0b","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"drug_verification","item":[],"id":"d91c6f9c-7ab9-4b4c-adef-09d0e6559507","description":"

Request Submission Object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
addressstringYesComplete Address13-B Gulmohar Society, Juhu, Mumbai, Maharashtra, India, 400054
test_typestringYesType of Drug Test
(Only certain values are allowed for this key/field. Allowed values are mentioned in the example column on right.)		\"Drug Test 3 Panel\"
\"Drug Test 5 Panel\"
\"Drug Test 6 Panel\"
\"Drug Test 7 Panel\"
\"Drug Test 8 Panel\"
\"Drug Test 9 Panel\"
\"Drug Test 10 Panel\"
\"Drug Test 11 Panel\"
\"Drug Test 12 Panel\"
\"Drug Test 5 Panel (Using hair)\"
\n
","_postman_id":"d91c6f9c-7ab9-4b4c-adef-09d0e6559507","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}}],"id":"24a3ef4f-42e4-49cb-8ca8-f0cb15586d55","_postman_id":"24a3ef4f-42e4-49cb-8ca8-f0cb15586d55","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}}],"id":"84dc1f69-16ca-4770-afde-f0ab34fa82b8","_postman_id":"84dc1f69-16ca-4770-afde-f0ab34fa82b8","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"Profile Invite Flow","item":[{"name":"Profile Invite","id":"e6b75b36-bcba-4097-982a-fda022d3eec7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group_id\": \"0c808367-3a60-45c2-9c18-369cd018cb6c\",\n \"profile_data\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"phone\": \"9898989898\",\n \"company_id\": \"5a9f6578-c06e-4212-a4cd-d75ecaa3a8a8\",\n \"package_id\": \"fbc11cd7-6c5a-4f6e-ad39-7d526622cda3\",\n \"date_of_birth\": \"13-12-1990\",\n \"additional_fields\": {\n \"date_of_joining\": \"04-01-2022\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dc.idfy.com/v2/invite","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","invite"],"host":["api","dc","idfy","com"],"query":[],"variable":[]}},"response":[{"id":"431b00c5-b5fe-4842-a6ad-e6e298c36265","name":"Profile Invite Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"apikey","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"group_id\": \"0c808367-3a60-45c2-9c18-369cd018cb6c\",\n \"profile_data\": {\n \"name\": \"John Doe\",\n \"email\": \"john@doe.com\",\n \"phone\": \"9898989898\",\n \"company_id\": \"5a9f6578-c06e-4212-a4cd-d75ecaa3a8a8\",\n \"package_id\": \"fbc11cd7-6c5a-4f6e-ad39-7d526622cda3\",\n \"date_of_birth\": \"13-12-1990\",\n \"additional_fields\": {\n \"date_of_joining\": \"04-01-2022\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dc.idfy.com/v2/invite"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"request_id\": \"c4856d16-aed9-405e-b541-046697bac410\",\n \"message\": \"Success\"\n}"}],"_postman_id":"e6b75b36-bcba-4097-982a-fda022d3eec7"},{"name":"Request ID - Profile Invite","id":"30abffee-7acb-4cc6-8197-6118f51211fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.dc.idfy.com/v2/invite?request_id=70c75755-fff7-451f-90c4-1299651353ba","description":"

Profile States

\n\n\n

Webhook

\n

We support 2 types of webhooks:

\n
    \n
  1. Profile completion callback
    2. \n
  2. Task completion callback
    3. \n
\n

Both, for now will be configured on the same webhook URL.

\n

You can pre-register a webhook URL with us. Whenever a task is completed, or the complete profile verification is completed, we would POST the result on this webhook

\n

The JSON body for webhook will be the same as the GET response. The webhook can only support basic authentication using username and password. Please refer the Profile Invite Examples Tab to view the JSON body.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","invite"],"host":["api","dc","idfy","com"],"query":[{"key":"request_id","value":"70c75755-fff7-451f-90c4-1299651353ba"}],"variable":[]}},"response":[{"id":"8cb1be51-efb9-47ce-8e79-3d8535249585","name":"Request ID - Profile Invite","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"{{apikey}}","type":"text"},{"key":"account","value":"","type":"text","disabled":true}],"url":{"raw":"https://api.dc.idfy.com/v2/invite?request_id=70c75755-fff7-451f-90c4-1299651353ba","protocol":"https","host":["api","dc","idfy","com"],"path":["v2","invite"],"query":[{"key":"request_id","value":"70c75755-fff7-451f-90c4-1299651353ba"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"group_id\": \"0c808367-3a60-45c2-9c18-369cd018cb6c\",\n \"profile_data\": {\n \"status\": \"green\",\n \"profile_id\": \"asd-4f99-fT1234-qwer2\",\n \"created_at\": \"2022-01-05T18:41:54+05:30\",\n \"completed_at\": \"2017-01-05T18:46:58+05:30\",\n \"tat\": \"2\"\n },\n \"tasks\": [\n {\n \"type\": \"experience_verification\",\n \"status\": \"green\",\n \"created_at\": \"2022-01-05T18:41:54+05:30\",\n \"completed_at\": \"2022-01-05T18:46:58+05:30\",\n \"tat\": \"2\",\n \"reason\": \"\"\n }\n ],\n \"pdf_report\": \"http://portal.idfy.com/artifacts/22222/fetch?t=1111\"\n}"}],"_postman_id":"30abffee-7acb-4cc6-8197-6118f51211fd"}],"id":"36d2fcd6-5c8b-45df-86b0-aa0d59556797","description":"

Request attributes

\n

Profile object attributes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
namestringYesName of the CandidateJohn Doe
emailstringYesEmail ID of the candidatejohn@doe.com
phonestringYesPhone Number of the candidate9898989898
date_of_birthstringYesDate of Birth of the candidate13-12-1990
fathers_namestringYesRequired for Court and Police verificationJames Doe
company_idstringYesUnique company ID. It is provided by IDfy.5a9f6578-c06e-4212-a4cd-d75ecaa3a8a8
package_idstringYesThe id of the package that needs to be applied to the profilefbc11cd7-6c5a-4f6e-ad39-7d526622cda3
\n

Additional Field object attributes available

\n

The fields in this object will be attached to the profile. The fields which are being sent should be pre configured with the IDfy team.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
date_of_joiningstringNoRequired for Experience Verification04-01-2022
\n

Ala-Carte object attributes

\n

Incase if you want to verify the tasks which are not supported in the package, you can send this ala-carte object in the request body.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
AttributesTypeMandatoryDescriptionExample
value of task typestringYescount of the tasks that needs to be verified againt the candidate2
\n

Task Type

\n

Refer task types section for the values of task types.

\n","_postman_id":"36d2fcd6-5c8b-45df-86b0-aa0d59556797","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"FAQs","item":[],"id":"e12a37a1-da1e-44ab-83be-e5ad072ee0fd","description":"

What auth methods are available for POST to IDfy for document URLs?

\n

Basic auth with username and password is available in case you do not wish to send public URLs.

\n

Will multiple profiles be created if client sends multiple POST API requests to IDfy?

\n

Do not send more profiles for same candidate in a minute. Have atleast 2 minutes duration.

\n

We have multiple child companies or business entities under our parent group? How do we send candidates profiles for different groups?

\n

IDfy can create multiple child companies or business entities. We will create that and then you can send different company_id's in POST API requests.

\n

Is there staging or sandbox access available as we do the integration?

\n

We don't have staging or sandbox access. We will share the apikey and company_id for you to send via POST a few profiles to IDfy. If successful, we would change the status for you to capture via GET or webhook call.

\n","_postman_id":"e12a37a1-da1e-44ab-83be-e5ad072ee0fd","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}},{"name":"Profile Creation Flow V3","item":[{"name":"Create Profile","id":"cf49df9f-de6c-4f4d-a21c-6fecfdf5f525","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"group_id\": \"e382a3d3b-1234-mnbg-tgvs-3d61d22c39909\",\n\t\"profile\": {\n\t\t\"name\": \"Jatin Schema Test\",\n\t\t\"email\": \"blahblah@hjhj.com\",\n\t\t\"phone\": \"9967684498\",\n\t\t\"package_public_id\": \"d8ad7757-cdab-475e-be38-6ef2dadace3e\",\n\t\t\"company_id\": \"62041ed0-4f00-4d6c-bc3d-1a73ae569829\",\n\t\t\"date_of_birth\": \"19-11-1993\",\n\t\t\"fathers_name\": \"father\",\n \"doc_urls\": [\n {\n \"label\": \"loa\",\n \"url\": \"https://storage.googleapis.com/storage.dc.idfy.com/attachments/29962398/original/ff06f77c-6848-418e-8516-a062782f433b.pdf?GoogleAccessId=idfy-ops-prod@idfy-1338.iam.gserviceaccount.com&Expires=1695202255&Signature=m9uIdXimxu%2FgWTK%2FTfgaym4o5am2FjK3Rglr%2FOQ85lhgYikXiCt%2BLYqTYwSwhJMFS4zkujpDOrQW%2FrEHXPyuke0od%2FyDDsYT6liv2FCBkmpDQRcUxXouCk3Ap6d42iijByRiyXx0bYe2PKU7%2FLqupQ00WnGDwlGj%2BfWIJI5pNm4WnBODjjMRZZsLW%2B5dLmrmhLzqe46ZL177Yu6QB1jSLtXLg0CLUEyIA%2BB7Lm4ghgwQ898SVJm6XuoPCZiA25cf4JdZnJbwSxM8rSdKW%2FyuZW8I66WqYbflQ%2FTZaXHhTTyj6P%2FDUsfMA2NQNKZmTcSRmM91Tt%2Fy6HFyXAHS5qmqEA%3D%3D\"\n }\n ]\n\t},\n\t\"data\": [{\n\t\t\t\"type\": \"address\",\n\t\t\t\"data\": {\n\t\t\t\t\"address_type\": \"Current\",\n\t\t\t\t\"street_address\": \"303 A dawd\",\n\t\t\t\t\"city\": \"Mumbai\",\n\t\t\t\t\"state\": \"Maharashtra\",\n\t\t\t\t\"country\": \"India\",\n\t\t\t\t\"pin\": \"400660\",\n\t\t\t\t\"landline_no\": \"\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"type\": \"address\",\n\t\t\t\"data\": {\n\t\t\t\t\"address_type\": \"Permanent\",\n\t\t\t\t\"street_address\": \"303 A dawd\",\n\t\t\t\t\"city\": \"Mumbai\",\n\t\t\t\t\"state\": \"Maharashtra\",\n\t\t\t\t\"country\": \"India\",\n\t\t\t\t\"pin\": \"400660\",\n\t\t\t\t\"landline_no\": \"\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"type\": \"pan\",\n\t\t\t\"data\": {\n\t\t\t\t\"pan_number\": \"ABCTY1234D\",\n\t\t\t\t\"doc_urls\": [{\n\t\t\t\t\t\"label\": \"document\",\n\t\t\t\t\t\"url\": \"http://www.africau.edu/images/default/sample.pdf\"\n\t\t\t\t}]\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"type\": \"voter\",\n\t\t\t\"data\": {\n\t\t\t\t\"voter_number\": \"ABCTY1234D\",\n\t\t\t\t\"doc_urls\": [{\n\t\t\t\t\t\"label\": \"document\",\n\t\t\t\t\t\"url\": \"http://www.africau.edu/images/default/sample.pdf\"\n\t\t\t\t}]\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"type\": \"passport\",\n\t\t\t\"data\": {\n\t\t\t\t\"passport_no\": \"ABCTY1234D\",\n\t\t\t\t\"passport_issuing_country\": \"\",\n\t\t\t\t\"doc_urls\": [{\n\t\t\t\t\t\"label\": \"document\",\n\t\t\t\t\t\"url\": \"http://www.africau.edu/images/default/sample.pdf\"\n\t\t\t\t}]\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"type\": \"driving_license\",\n\t\t\t\"data\": {\n\t\t\t\t\"driving_license_number\": \"ABCTY1234D\",\n\t\t\t\t\"state\": \"Maharashtra\",\n\t\t\t\t\"doc_urls\": [{\n\t\t\t\t\t\"label\": \"document\",\n\t\t\t\t\t\"url\": \"http://www.africau.edu/images/default/sample.pdf\"\n\t\t\t\t}]\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"type\": \"reference\",\n\t\t\t\"data\": {\n\t\t\t\t\"name_of_referee\": \"Tom Clarke\",\n\t\t\t\t\"relationship_with_candidate\": \"Manager Nagar\",\n\t\t\t\t\"referee_organization\": \"Infosys\",\n\t\t\t\t\"referee_contact_number\": \"9898989899\",\n\t\t\t\t\"referee_email_address\": \"something@idfy.com\",\n\t\t\t\t\"candidate_organization_same_as_referee\": \"No\",\n\t\t\t\t\"referee_reporting_manager\": \"Yes\"\n\t\t\t}\n\t\t},\n {\n\t\t\t\"type\": \"reference\",\n\t\t\t\"data\": {\n\t\t\t\t\"name_of_referee\": \"Tom Clarke\",\n\t\t\t\t\"relationship_with_candidate\": \"Manager Nagar\",\n\t\t\t\t\"referee_organization\": \"Infosys\",\n\t\t\t\t\"referee_contact_number\": \"9898989899\",\n\t\t\t\t\"referee_email_address\": \"something@idfy.com\",\n\t\t\t\t\"candidate_organization_same_as_referee\": \"No\",\n\t\t\t\t\"referee_reporting_manager\": \"Yes\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"type\": \"experience\",\n\t\t\t\"data\": {\n\t\t\t\t\"name_of_organization\": \"Infosys\",\n\t\t\t\t\"employee_id\": \"2312321\",\n\t\t\t\t\"designation\": \"SDE\",\n\t\t\t\t\"date_of_joining\": \"23-05-2022\",\n\t\t\t\t\"currently_working\": \"no\",\n\t\t\t\t\"last_working_date\": \"27-06-2022\",\n\t\t\t\t\"organization_street_address\": \"4F Rushabh Chambers\",\n\t\t\t\t\"organization_city\": \"Mumbai\",\n\t\t\t\t\"organization_state\": \"Maharashtra\",\n\t\t\t\t\"organization_country\": \"India\",\n\t\t\t\t\"organization_pin_code\": \"400058\",\n\t\t\t\t\"supervisor_name\": \"Tom Clarke\",\n\t\t\t\t\"supervisor_designation\": \"Manager\",\n\t\t\t\t\"supervisor_email\": \"manager@infosys.com\",\n\t\t\t\t\"supervisor_phone\": \"9898989898\",\n\t\t\t\t\"doc_urls\": [{\n\t\t\t\t\t\"label\": \"document\",\n\t\t\t\t\t\"url\": \"http://www.africau.edu/images/default/sample.pdf\"\n\t\t\t\t}]\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"type\": \"experience\",\n\t\t\t\"data\": {\n\t\t\t\t\"name_of_organization\": \"2 Infosys\",\n\t\t\t\t\"employee_id\": \"2312321\",\n\t\t\t\t\"designation\": \"SDE\",\n\t\t\t\t\"date_of_joining\": \"23-05-2022\",\n\t\t\t\t\"currently_working\": \"no\",\n\t\t\t\t\"last_working_date\": \"27-06-2022\",\n\t\t\t\t\"organization_street_address\": \"4F Rushabh Chambers\",\n\t\t\t\t\"organization_city\": \"Mumbai\",\n\t\t\t\t\"organization_state\": \"Maharashtra\",\n\t\t\t\t\"organization_country\": \"India\",\n\t\t\t\t\"organization_pin_code\": \"400058\",\n\t\t\t\t\"supervisor_name\": \"Tom Clarke\",\n\t\t\t\t\"supervisor_designation\": \"Manager\",\n\t\t\t\t\"supervisor_email\": \"manager@infosys.com\",\n\t\t\t\t\"supervisor_phone\": \"9898989898\",\n\t\t\t\t\"doc_urls\": [{\n\t\t\t\t\t\"label\": \"document\",\n\t\t\t\t\t\"url\": \"http://www.africau.edu/images/default/sample.pdf\"\n\t\t\t\t}]\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"type\": \"qualification\",\n\t\t\t\"data\": {\n\t\t\t\t\"degree_name\": \"B.Tech\",\n\t\t\t\t\"specialization_or_major\": \"Computer Science\",\n\t\t\t\t\"institute\": \"IIT\",\n\t\t\t\t\"certifying_authority\": \"IGNOU\",\n\t\t\t\t\"roll_number\": \"25254\",\n\t\t\t\t\"grade\": \"First\",\n\t\t\t\t\"course_completed_on\": \"14-06-2014\",\n \"doc_urls\": [{\n\t\t\t\t\t\"label\": \"document\",\n\t\t\t\t\t\"url\": \"http://www.africau.edu/images/default/sample.pdf\"\n\t\t\t\t}]\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"type\": \"qualification\",\n\t\t\t\"data\": {\n\t\t\t\t\"degree_name\": \"B.Tech\",\n\t\t\t\t\"specialization_or_major\": \"Computer Science\",\n\t\t\t\t\"institute\": \"IIT\",\n\t\t\t\t\"certifying_authority\": \"IGNOU\",\n\t\t\t\t\"roll_number\": \"25254\",\n\t\t\t\t\"course_completed_on\": \"14-06-2014\",\n \"doc_urls\": [{\n\t\t\t\t\t\"label\": \"document\",\n\t\t\t\t\t\"url\": \"http://www.africau.edu/images/default/sample.pdf\"\n\t\t\t\t}]\n\t\t\t}\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dc.idfy.com/v3/profiles","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","profiles"],"host":["api","dc","idfy","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf49df9f-de6c-4f4d-a21c-6fecfdf5f525"},{"name":"GET Request ID","id":"277d138e-c123-4d80-80c8-21d045f1cfbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apikey","value":"{{api-key}}","type":"text"}],"url":"https://api.dc.idfy.com/v2/invite?request_id={{request_id}}","description":"

GET

\n

A successful POST in the previous step to create profile will return a request ID in the response. You can check the state or status of a profile you created, by doing a GET on with that returned request ID. Note how the request ID has to be added in the endpoint.

\n

Profile State

\n

Following profiles statues can be specified in the GET or the webhook responses

\n\n\n

Webhook

\n

We support 2 types of webhooks:

\n
    \n
  1. Profile completion callback
    2. \n
  2. Task completion callback
    3. \n
\n

Both will be configured on the same webhook URL.

\n

You can pre-register a webhook URL with us. Whenever a task is completed, or the complete profile verification is completed, IDfy would POST the result on this webhook.

\n

Note that the JSON body for the webhook is same as the GET response. The webhook can only support basic authentication using username and password.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}},"urlObject":{"protocol":"https","path":["v2","invite"],"host":["api","dc","idfy","com"],"query":[{"key":"request_id","value":"{{request_id}}"}],"variable":[]}},"response":[{"id":"a779ad43-d774-47e9-a11f-f8aeaca80209","name":"Request ID - Profile Create","originalRequest":{"method":"GET","header":[{"key":"apikey","value":"{{api-key}}","type":"text"}],"url":{"raw":"https://api.dc.idfy.com/v2/invite?request_id={{request_id}}","protocol":"https","host":["api","dc","idfy","com"],"path":["v2","invite"],"query":[{"key":"request_id","value":"{{request_id}}"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"group_id\": \"0c808367-3a60-45c2-9c18-369cd018cb6c\",\n \"profile_data\": {\n \"status\": \"green\",\n \"profile_id\": \"asd-4f99-fT1234-qwer2\",\n \"created_at\": \"2022-01-05T18:41:54+05:30\",\n \"completed_at\": \"2017-01-05T18:46:58+05:30\",\n \"tat\": \"2\"\n },\n \"tasks\": [\n {\n \"type\": \"experience_verification\",\n \"status\": \"green\",\n \"created_at\": \"2022-01-05T18:41:54+05:30\",\n \"completed_at\": \"2022-01-05T18:46:58+05:30\",\n \"tat\": \"2\",\n \"reason\": \"\"\n }\n ],\n \"pdf_report\": \"http://portal.idfy.com/artifacts/22222/fetch?t=1111\"\n}"}],"_postman_id":"277d138e-c123-4d80-80c8-21d045f1cfbe"}],"id":"ec379b38-aacb-4c34-8e12-7d5f106ed045","description":"

Revamped version for Profile Creation API V2 for very specific usecases.

\n

Ignore if not recommended by your IDfy integration SPOC.

\n","_postman_id":"ec379b38-aacb-4c34-8e12-7d5f106ed045","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","id":"6a87b0ba-260e-4df1-afcb-b42309c0cd06","name":"IDfy's Background Verification APIs","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"21577ed5-0283-446a-8325-e2472913ecc7","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"49f14016-acca-473e-9a99-7aa4720205ff","type":"text/javascript","packages":{},"exec":[""]}}]}