{"info":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","description":"

Vetty Restful API allows customers to seamlessly integrate background checks into their workflow and manage the process and get notifications from customer’s system.

This Programming Guide is designed to help customers get up-and-running with Vetty's background screening services, both by providing the necessary context to understand the background screening industry and its regulations, and by giving technical guidance on how to work with the Vetty API.

Getting Started

Step 1: Get access token

Get API keys: Get your keys from API section of your Client Dashboard. After you login to Client Dashboard, navigate to Settings -> API Management -> API Management System, and add a new API key. Each API key is associated with an IP range, requests should be made from the IP range defined for the API key.
\n
Bearer Token: You can use the token from the previous step as Bearer Token when making any of the API calls. Pass the token as Authorization header with value Bearer .
\n

Step 2: Create an Applicant

_POST /applicants_

Minimum fields for creating an application are (first name, last name, email). Further fields will likely be needed to initiate a screening on the applicant.

Step 3: Upload required documents

_POST /applicants/{applicant_id}/documents_

Upload required documents for screening.

Step 4: Create a Screening

POST /screenings

You will need a applicantId and packageId in order to create a screening. You can get the packageId by logging into Client Dashboard, after login, click on Packages in the left navigation and click on Get Package ID for the package you want to select for screening. You have 2 workflow options for creating a screening.

Send the candidate an email invite.
\n
If all required candidate fields already exist, simply initiate the screening.
\n

Step 5: Get Screening status

GET /screenings/{screening_id}

Get the status of the screening by calling GET /screening/{screening_id} endpoint.

Screening

In order to screen an applicant, we need to collect data like, date of birth, ssn, etc... Vetty supports two forms of data collection.

Client Data Collection Flow: In this flow, client collects all the required data to run the screenings and submits them as part of the applicant creation.
\n
- { \"first_name\": \"John\", \"last_name\": \"Doe\", \"middle_name\": \"\", \"middle_name_exists\": false, \"email\": \"john.doe@vetty.co\", \"dob\": \"1993-01-05\", \"ssn\": \"1231111234\", \"phone\": \"(441) 111-1111\", \"address\": { \"street\": \"123 Main St\", \"city\": \"New York\", \"state\": \"NY\", \"county\": \"New York\", \"zipcode\": \"10011\", \"country\": \"USA\" }, \"driver_license\": { \"number\": \"111-222-3333\", \"state\": \"NY\" }}
  \n
- { \"applicant_id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\", \"package_id\": \"3654242b-16ac-42ee-8e00-bc27d49d47d1\"}
  \n
- GET /screenings/{screening_id}
  Get the status of screening
  \n
\n
Vetty Data Collection Flow: In this flow, client creates an applicant with basic information and initiates email invite.
\n
- { \"first_name\": \"John\", \"last_name\": \"Doe\", \"email\": \"john.doe@vetty.co\",}
  \n
- { \"applicant_id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\", \"package_id\": \"3654242b-16ac-42ee-8e00-bc27d49d47d1\", \"invite\": { \"method\": \"email\" }}
  \n
- { \"first_name\": \"John\", \"last_name\": \"Doe\", \"middle_name\": \"\", \"middle_name_exists\": false, \"email\": \"john.doe@vetty.co\", \"dob\": \"1993-01-05\", \"ssn\": \"1231111234\", \"phone\": \"(441) 111-1111\", \"address\": { \"street\": \"123 Main St\", \"city\": \"New York\", \"state\": \"NY\", \"county\": \"New York\", \"zipcode\": \"10011\", \"country\": \"USA\" }, \"driver_license\": { \"number\": \"111-222-3333\", \"state\": \"NY\" }}
  \n
- GET /screenings/{screening_id}
  Get the status of screening
  \n
\n

Webhook:

Steps to add webhook:

Login to Vetty client portal
\n
Navigate to Setting tab -> Go to API Management -> Go to WebHook
\n
Click on the Add WebHook button
\n
Add URL and secret key and then click on Add to save the data.
\n
- URL begins with HTTPS secure protocol
  \n
- Secret key count be any string value
  \n
\n

Webhook call and process:

When the event occurs, the URL specified in the webhook will be called as a POST with the payload from the event, e.g.,

{\"applicant_id\": \"5fd37fac6676c40007728c66\", \"status\": \"archived\"}\n\n

In addition to the payload, vetty-sign header is sent as part of the request, this header can be used to authenticate the request is generated by Vetty.

The value in the header is generated as below:

Encode the secret key and payload data using UTF-8 and convert to bytes.
\n
Create an SHA-256 Hash of the above data
\n
Convert the above data into Hexadecimal format
\n

API Rate Limiter

Vetty API ensures fair usage of the API among all the users by only allowing 20000 requests per day which is 800 requests per hour.

Environments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Environment	Host	Purpose
UAT (Sandbox)	`https://uatapi.vetty.co`	Testing and development
Production	`https://api.vetty.co`	Live screenings

Please use the UAT environment to test your integration before going live. Once your integration is working as expected, update your host URL to production.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"925449","collectionId":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","publishedId":"T17M8S81","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-12-29T15:23:17.000Z"},"item":[{"name":"API Endpoints","item":[{"name":"Applicant","item":[{"name":"Create a new applicant","id":"2a6c1f7c-585e-46cd-b137-5012853147a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"4411111111\",\n \"external_id\": \"123111123124\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"driver_license\": {\n \"number\": \"1112223333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"number\": \"1112223334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [\n {\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\": \"Software Systems\",\n \"degree_name\": \"Bachelors\",\n \"degree_type\": \"Masters\",\n \"graduation_date\": \"2010-06-01\",\n \"degree_completed\": true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"employment_history\": [\n {\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"john.doe@vetty.co\",\n \"relationship\": \"Manager\",\n \"other_relationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employee_authorized_representative\",\n \"repr_email\": \"john.doe@vetty.co\",\n \"repr_phone\": \"4411111111\"\n }\n },\n \"healthcare_license\": [\n {\n \"license_code\": \"acupuncturist_license\",\n \"candidate_name\": \"John doey\",\n \"certifying_body\": \"vetty verify\",\n \"license_number\": \"DQ128h8WD\",\n \"issued_state\": \"CA\",\n \"license_issued_date\": \"mm-yyyy\",\n \"license_issued_expiry\": \"mm-yyyy\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\"\n ]\n }\n ],\n \"expected_empstartdate\": \"2023-06-20\",\n \"send_sms\" : true,\n \"cost_center_id\": \"b4f23666-6805-4fa4-nceb-443f8b754gde\",\n \"department\": \"6759059bd90cf07c450965ea\",\n \"expected_annual_salary\": 10000\n}"},"url":"{{host}}/cfapi/v1/applicants","description":"

Creates a new applicant

\n","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}},"urlObject":{"path":["cfapi","v1","applicants"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"5ab39deb-d152-431b-b70f-9b6cf49da36b","name":"New applicant will all data","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"(441) 111-1111\",\n \"external_id\": \"123111123124\",\n \"expected_annual_salary\": 10000,\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"expected_empstartdate\": \"2023-06-20\",\n \"send_sms\": true,\n \"cost_center_id\": \"b4f23666-6805-4fa4-nceb-443f8b754gde\",\n \"department\": \"6759059bd90cf07c450965ea\",\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"number\": \"111-222-3334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [\n {\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\": \"Software Systems\",\n \"degree_name\": \"Bachelors\",\n \"degree_type\": \"Masters\",\n \"graduation_date\": \"2010-06-01\",\n \"degree_completed\": true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"employment_history\": [\n {\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"harmeet+10.hybrid.client@vetty.co\",\n \"relationship\": \"Manager\",\n \"otherRelationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employee_authorized_representative\",\n \"repr_email\": \"john.doe@vetty.co\",\n \"repr_phone\": \"4411111111\"\n }\n },\n \"healthcare_license\": [\n {\n \"license_code\": \"acupuncturist_license\",\n \"candidate_name\": \"John doey\",\n \"certifying_body\": \"vetty verify\",\n \"license_number\": \"DQ128h8WD\",\n \"issued_state\": \"CA\",\n \"license_issued_date\": \"mm-yyyy\",\n \"license_issued_expiry\": \"mm-yyyy\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/applicants"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"(441) 111-1111\",\n \"external_id\": \"123111123124\",\n \"expected_annual_salary\": 10000,\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"expected_empstartdate\": \"2023-06-20\",\n \"send_sms\" : true,\n \"cost_center_id\": \"b4f23666-6805-4fa4-nceb-443f8b754gde\",\n \"department\": \"6759059bd90cf07c450965ea\",\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770b1\",\n \"number\": \"111-222-3334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770c1\",\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\":\"Software Systems\",\n \"degree_name\":\"Bachelors\",\n \"degree_type\":\"Masters\",\n \"graduation_date\":\"2010-06-01\",\n \"degree_completed\":true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }],\n \"employment_history\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770d1\",\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770e1\",\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"harmeet+10.hybrid.client@vetty.co\",\n \"relationship\": \"Manager\",\n \"otherRelationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employee_authorized_representative\",\n \"repr_email\": \"john.doe@vetty.co\",\n \"repr_phone\": \"4411111111\"\n }\n },\n \"healthcare_license\": [\n {\n \"license_code\": \"acupuncturist_license\",\n \"candidate_name\": \"John doey\",\n \"certifying_body\": \"vetty verify\",\n \"license_number\": \"DQ128h8WD\",\n \"issued_state\": \"CA\",\n \"license_issued_date\": \"mm-yyyy\",\n \"license_issued_expiry\": \"mm-yyyy\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\"\n ]\n }\n ]\n}"},{"id":"f27bcf07-ea10-4d78-8cfb-a0427792b7c3","name":"New applicant with basic data","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@vetty.co\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/applicants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@vetty.co\"\n}"},{"id":"367cad52-5cfe-4a17-9974-806125c9d2fa","name":"New applicant with - healthcare license","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"(441) 111-1111\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"expected_empstartdate\": \"2023-06-20\",\n \"send_sms\": true,\n \"cost_center_id\": \"b4f23666-6805-4fa4-nceb-443f8b754gde\",\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"number\": \"111-222-3334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [\n {\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\": \"Software Systems\",\n \"degree_name\": \"Bachelors\",\n \"degree_type\": \"Masters\",\n \"graduation_date\": \"2010-06-01\",\n \"degree_completed\": true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"employment_history\": [\n {\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"harmeet+10.hybrid.client@vetty.co\",\n \"relationship\": \"Manager\",\n \"otherRelationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employee_authorized_representative\",\n \"repr_email\": \"john.doe@vetty.co\",\n \"repr_phone\": \"4411111111\"\n }\n },\n \"healthcare_license\": [\n {\n \"license_code\": \"acupuncturist_license\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/applicants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"(441) 111-1111\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"expected_empstartdate\": \"2023-06-20\",\n \"send_sms\" : true,\n \"cost_center_id\": \"b4f23666-6805-4fa4-nceb-443f8b754gde\",\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770b1\",\n \"number\": \"111-222-3334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770c1\",\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\":\"Software Systems\",\n \"degree_name\":\"Bachelors\",\n \"degree_type\":\"Masters\",\n \"graduation_date\":\"2010-06-01\",\n \"degree_completed\":true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }],\n \"employment_history\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770d1\",\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770e1\",\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"harmeet+10.hybrid.client@vetty.co\",\n \"relationship\": \"Manager\",\n \"otherRelationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employee_authorized_representative\",\n \"repr_email\": \"john.doe@vetty.co\",\n \"repr_phone\": \"4411111111\"\n }\n },\n \"healthcare_license\": [\n {\n \"license_code\": \"acupuncturist_license\"\n }\n ]\n}"},{"id":"ff7266e1-fc9e-4c16-bfbd-269f5717fe24","name":"New applicant with - healthcare license complete information","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"(441) 111-1111\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"expected_empstartdate\": \"2023-06-20\",\n \"send_sms\": true,\n \"cost_center_id\": \"b4f23666-6805-4fa4-nceb-443f8b754gde\",\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"number\": \"111-222-3334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [\n {\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\": \"Software Systems\",\n \"degree_name\": \"Bachelors\",\n \"degree_type\": \"Masters\",\n \"graduation_date\": \"2010-06-01\",\n \"degree_completed\": true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"employment_history\": [\n {\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"harmeet+10.hybrid.client@vetty.co\",\n \"relationship\": \"Manager\",\n \"otherRelationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employee_authorized_representative\",\n \"repr_email\": \"john.doe@vetty.co\",\n \"repr_phone\": \"4411111111\"\n }\n },\n \"healthcare_license\": [\n {\n \"license_code\": \"acupuncturist_license\",\n \"candidate_name\": \"John doey\",\n \"certifying_body\": \"vetty verify\",\n \"license_number\": \"DQ128h8WD\",\n \"issued_state\": \"CA\",\n \"license_issued_date\": \"mm-yyyy\",\n \"license_issued_expiry\": \"mm-yyyy\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/applicants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"(441) 111-1111\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"expected_empstartdate\": \"2023-06-20\",\n \"send_sms\" : true,\n \"cost_center_id\": \"b4f23666-6805-4fa4-nceb-443f8b754gde\",\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770b1\",\n \"number\": \"111-222-3334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770c1\",\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\":\"Software Systems\",\n \"degree_name\":\"Bachelors\",\n \"degree_type\":\"Masters\",\n \"graduation_date\":\"2010-06-01\",\n \"degree_completed\":true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }],\n \"employment_history\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770d1\",\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770e1\",\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"harmeet+10.hybrid.client@vetty.co\",\n \"relationship\": \"Manager\",\n \"otherRelationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employee_authorized_representative\",\n \"repr_email\": \"john.doe@vetty.co\",\n \"repr_phone\": \"4411111111\"\n }\n },\n \"healthcare_license\": [\n {\n \"license_code\": \"acupuncturist_license\",\n \"candidate_name\": \"John doey\",\n \"certifying_body\": \"vetty verify\",\n \"license_number\": \"DQ128h8WD\",\n \"issued_state\": \"CA\",\n \"license_issued_date\": \"mm-yyyy\",\n \"license_issued_expiry\": \"mm-yyyy\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\"\n ]\n }\n ]\n}"},{"id":"5cbd90c9-5730-4b35-90a8-8484dbe756e3","name":"New applicant with I9 - Employee Authorized Representative","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"(441) 111-1111\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"number\": \"111-222-3334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [\n {\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\": \"Software Systems\",\n \"degree_name\": \"Bachelors\",\n \"degree_type\": \"Masters\",\n \"graduation_date\": \"2010-06-01\",\n \"degree_completed\": true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"employment_history\": [\n {\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"harmeet+10.hybrid.client@vetty.co\",\n \"relationship\": \"Manager\",\n \"otherRelationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employee_authorized_representative\",\n \"repr_email\": \"john.doe@vetty.co\",\n \"repr_phone\": \"4411111111\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/applicants"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"(441) 111-1111\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770b1\",\n \"number\": \"111-222-3334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770c1\",\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\":\"Software Systems\",\n \"degree_name\":\"Bachelors\",\n \"degree_type\":\"Masters\",\n \"graduation_date\":\"2010-06-01\",\n \"degree_completed\":true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }],\n \"employment_history\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770d1\",\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770e1\",\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"harmeet+10.hybrid.client@vetty.co\",\n \"relationship\": \"Manager\",\n \"otherRelationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employee_authorized_representative\",\n \"repr_email\": \"john.doe@vetty.co\",\n \"repr_phone\": \"4411111111\"\n }\n }\n}"},{"id":"aa2fe728-4e7d-43ed-a883-352406dda35a","name":"New applicant with I9 - Employer Physical Verification","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"(441) 111-1111\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"number\": \"111-222-3334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [\n {\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\": \"Software Systems\",\n \"degree_name\": \"Bachelors\",\n \"degree_type\": \"Masters\",\n \"graduation_date\": \"2010-06-01\",\n \"degree_completed\": true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"employment_history\": [\n {\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"harmeet+10.hybrid.client@vetty.co\",\n \"relationship\": \"Manager\",\n \"otherRelationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employer_physical_verification\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/applicants"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"(441) 111-1111\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770b1\",\n \"number\": \"111-222-3334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770c1\",\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\":\"Software Systems\",\n \"degree_name\":\"Bachelors\",\n \"degree_type\":\"Masters\",\n \"graduation_date\":\"2010-06-01\",\n \"degree_completed\":true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }],\n \"employment_history\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770d1\",\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770e1\",\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"harmeet+10.hybrid.client@vetty.co\",\n \"relationship\": \"Manager\",\n \"otherRelationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employer_physical_verification\"\n }\n }\n}"},{"id":"562f0ff5-c9e4-438d-9d0f-e14aa626e8fe","name":"New applicant with department","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@vetty.co\",\n \"department\": \"6759059bd90cf07c450965ea\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/applicants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@vetty.co\",\n \"department\": \"6759059bd90cf07c450965ea\"\n}"},{"id":"c1396ad2-7db4-4d60-964c-4685f9cc15ad","name":"Create a new applicant - Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/applicants"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"error message\"\n}"}],"_postman_id":"2a6c1f7c-585e-46cd-b137-5012853147a6"},{"name":"Get all applicants","id":"fa14be94-d19e-4003-adf2-96d763e670f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{host}}/cfapi/v1/applicants?page=0&size=100&status=in_progress&historical=false","description":"

Get all applicants, you can filter the list by passing in the screening status query parameter. Here are the valid status values: in_progress, approval_needed, clear, review_required, inconclusive, error, idv_fail, archived, adverse, dispute_under_review, pre_adverse, accepted, not_meet_hiring_criteria, coi_expired and inconclusive_ca. This endpoint will return any active applicants matching filter criteria. If no matching records are found, response will contain only the \"message\" field. Be ware that older applicants will eventually be moved into historical storage and could be retrieved using query parameter \"historical\" with value of \"true\". For applicant to be moved to historical storage their background check must be completed and date of creation should be over 2 months ago.

[Note: updated_date timestamp only changed on major applicant events and is not changed in other cases]

Zero based index

\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"

The page size to be returned, max 1000

\n","type":"text/plain"},"key":"size","value":"100"},{"description":{"content":"

Applicant status

\n","type":"text/plain"},"key":"status","value":"in_progress"},{"key":"historical","value":"false"}],"variable":[]}},"response":[{"id":"b3567d2b-529d-447c-87b4-68f0542e507c","name":"Get all applicants","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/cfapi/v1/applicants?page=0&size=100","host":["{{host}}"],"path":["cfapi","v1","applicants"],"query":[{"key":"page","value":"0","description":"Zero based index"},{"key":"size","value":"100","description":"The page size to be returned"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\" : [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"status\": \"applicant_created\",\n \"updated_date\": \"2023-05-11 10:22:59\",\n \"historical\": false\n }\n ],\n \"last\": true,\n \"total_elements\" : 1,\n \"total_pages\" : 1\n}"},{"id":"75f6e46c-1ad5-4b43-92ec-5f6fe56fed89","name":"Get all applicants with historical applicants","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/cfapi/v1/applicants?page=0&size=100&historical=true","host":["{{host}}"],"path":["cfapi","v1","applicants"],"query":[{"key":"page","value":"0","description":"Zero based index"},{"key":"size","value":"100","description":"The page size to be returned"},{"key":"historical","value":"true"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\" : [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"status\": \"applicant_created\",\n \"updated_date\": \"2023-05-11 10:22:59\",\n \"historical\": true\n },\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c4477h2f\",\n \"first_name\": \"Max\",\n \"last_name\": \"Fried\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"max.fried@vetty.co\",\n \"status\": \"clear\",\n \"updated_date\": \"2025-03-17 03:27:12\",\n \"historical\": false\n }\n ],\n \"last\": true,\n \"total_elements\" : 2,\n \"total_pages\" : 1\n}"},{"id":"7d562223-34cf-43ba-9b78-e08bb8cdc47d","name":"Create a all applicants - Bad Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/cfapi/v1/applicants"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"error message\"\n}"}],"_postman_id":"fa14be94-d19e-4003-adf2-96d763e670f8"},{"name":"Update an existing applicant","id":"90347c73-bd8e-4344-b86a-e1573c62fb47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"4411111111\",\n \"external_id\": \"123111123124\",\n \"expected_annual_salary\": 10000,\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"driver_license\": {\n \"number\": \"1112223333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"number\": \"1112223334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [{\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\":\"Software Systems\",\n \"degree_name\":\"Bachelors\",\n \"degree_type\":\"Masters\",\n \"graduation_date\":\"2010-06-01\",\n \"degree_completed\":true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }],\n \"employment_history\": [\n {\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"harmeet+10.hybrid.client@vetty.co\",\n \"relationship\": \"Manager\",\n \"other_relationship\": \"\", \n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employee_authorized_representative\",\n \"repr_email\": \"john.doe@vetty.co\",\n \"repr_phone\": \"4411111111\"\n }\n },\n \"healthcare_license\": [\n {\n \"license_code\": \"acupuncturist_license\",\n \"candidate_name\": \"John doey\",\n \"certifying_body\": \"vetty verify\",\n \"license_number\": \"DQ128h8WD\",\n \"issued_state\": \"CA\",\n \"license_issued_date\": \"mm-yyyy\",\n \"license_issued_expiry\": \"mm-yyyy\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\"\n ]\n }\n ],\n \"expected_empstartdate\": \"2023-06-20\",\n \"send_sms\" : true,\n \"cost_center_id\" : \"b4f23666-6805-4fa4-nceb-443f8b754gde\",\n \"department\": \"6759059bd90cf07c450965ea\"\n}"},"url":"{{host}}/cfapi/v1/applicants/{applicant_id}","description":"

Creates a new applicant

Retrieve an existing applicant.
[Note: This will not retrive an historical data. Support for historical data will be added soon]

[Note2: updated_date timestamp only changed on major applicant events and is not changed in other cases]

\n","urlObject":{"path":["cfapi","v1","applicants","{applicant_id}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"7283bc47-95a3-4fc7-b7b5-2f14a72520dd","name":"Retrieve an existing applicant","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/cfapi/v1/applicants/{applicant_id}","host":["{{host}}"],"path":["cfapi","v1","applicants","{applicant_id}"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"phone\": \"(441) 111-1111\",\n \"status\": \"applicant_created\",\n \"updated_date\": \"2023-05-11 10:22:59\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"zipcode\": \"10011\"\n },\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n }\n}"},{"id":"40af23b3-c5a4-430b-9a43-2037a54e63d4","name":"Retrieve an existing historical applicant","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/cfapi/v1/applicants/{applicant_id}?historical=true","host":["{{host}}"],"path":["cfapi","v1","applicants","{applicant_id}"],"query":[{"key":"historical","value":"true"},{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"phone\": \"(441) 111-1111\",\n \"status\": \"applicant_created\",\n \"updated_date\": \"2023-05-11 10:22:59\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"zipcode\": \"10011\"\n },\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n }\n}"},{"id":"9802dc0e-dc6f-41e6-9902-f82ce44534b5","name":"Retrieve an existing applicant - Health Screening Scheduling Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/cfapi/v1/applicants/{applicant_id}","host":["{{host}}"],"path":["cfapi","v1","applicants","{applicant_id}"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"phone\": \"(441) 111-1111\",\n \"status\": \"applicant_created\",\n \"updated_date\": \"2023-05-11 10:22:59\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"zipcode\": \"10011\"\n },\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"scheduling_details\": [\n {\n \"checks\": [\n \"10 Panel Drug\",\n \"MMR Titer\",\n \"Hepatitis B Surface AntiBody, Quantitative\",\n \"Varicella Titer\"\n ],\n \"name\": \"AFC Urgent Care - Torrance\",\n \"address\": \"24329 Crenshaw Blvd Ste A\",\n \"city\": \"Torrance\",\n \"state\": \"CA\",\n \"country\": \"\",\n \"zip\": \"90505-5335\",\n \"phone\": \"3108688100\",\n \"mon\": \"08:00 - 16:30\",\n \"tue\": \"08:00 - 16:30\",\n \"wed\": \"08:00 - 16:30\",\n \"thu\": \"08:00 - 16:30\",\n \"fri\": \"08:00 - 16:30\",\n \"sat\": \"Closed\",\n \"sun\": \"Closed\",\n \"expiry_date\": \"Tuesday, May 16, 2023\",\n \"message\": \"\",\n \"donor_pass_uri\": \"https://stgapi.vetty.co/cfapi/v1/return_file?file_id=645ccb480349b9a3eba92091\"\n }\n ]\n}"},{"id":"ab6740a4-bd0c-45f7-bad8-7fbf04926fd2","name":"Retrieve an existing applicant - Health Screening Scheduling Failed","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/cfapi/v1/applicants/{applicant_id}","host":["{{host}}"],"path":["cfapi","v1","applicants","{applicant_id}"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"phone\": \"(441) 111-1111\",\n \"status\": \"applicant_created\",\n \"updated_date\": \"2023-05-11 10:22:59\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"zipcode\": \"10011\"\n },\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"scheduling_details\": [\n {\n \"checks\": [\n \"10 Panel Drug\",\n \"MMR Titer\",\n \"Hepatitis B Surface AntiBody, Quantitative\",\n \"Varicella Titer\"\n ],\n \"message\": \"Please Reschedule to try again\"\n },\n {\n \"checks\": [\n \"MMR Vaccine\"\n ],\n \"message\": \"Please Reschedule to try again\"\n }\n ]\n}"},{"id":"f201ffc3-1839-49e9-9b1a-976965f204e9","name":"Retrieve an existing applicant - Health Screening Scheduling Expired","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/cfapi/v1/applicants/{applicant_id}","host":["{{host}}"],"path":["cfapi","v1","applicants","{applicant_id}"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"phone\": \"(441) 111-1111\",\n \"status\": \"applicant_created\",\n \"updated_date\": \"2023-05-11 10:22:59\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"zipcode\": \"10011\"\n },\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"scheduling_details\": [\n {\n \"checks\": [\n \"10 Panel Drug\",\n \"MMR Titer\",\n \"Hepatitis B Surface AntiBody, Quantitative\",\n \"Varicella Titer\"\n ],\n \"message\": \"This health screening is expired on Tuesday, May 16, 2023\"\n },\n {\n \"checks\": [\n \"Mask Fit\"\n ],\n \"message\": \"This health screening is expired on Tuesday, May 16, 2023\"\n }\n ]\n}"}],"_postman_id":"c2d45ac5-6b61-49d5-8202-241834eb7a66"},{"name":"Create full applicant","id":"4ba4e602-259e-4d8f-9692-eb2b5183228b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"4411111111\",\n \"external_id\": \"123111123124\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"driver_license\": {\n \"number\": \"1112223333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"number\": \"1112223334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [\n {\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\": \"Software Systems\",\n \"degree_name\": \"Bachelors\",\n \"degree_type\": \"Masters\",\n \"graduation_date\": \"2010-06-01\",\n \"degree_completed\": true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"employment_history\": [\n {\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"john.doe@vetty.co\",\n \"relationship\": \"Manager\",\n \"other_relationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employee_authorized_representative\",\n \"repr_email\": \"john.doe@vetty.co\",\n \"repr_phone\": \"4411111111\"\n }\n },\n \"healthcare_license\": [\n {\n \"license_code\": \"acupuncturist_license\",\n \"candidate_name\": \"John doey\",\n \"certifying_body\": \"vetty verify\",\n \"license_number\": \"DQ128h8WD\",\n \"issued_state\": \"CA\",\n \"license_issued_date\": \"mm-yyyy\",\n \"license_issued_expiry\": \"mm-yyyy\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\"\n ]\n }\n ],\n \"expected_empstartdate\": \"2023-06-20\",\n \"send_sms\" : true,\n \"cost_center_id\": \"b4f23666-6805-4fa4-nceb-443f8b754gde\",\n \"department\": \"6759059bd90cf07c450965ea\"\n}"},"url":"{{host}}/cfapi/v1/applicants","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}},"urlObject":{"path":["cfapi","v1","applicants"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"ef518578-7d02-401b-841c-40d6a53ba2bf","name":"Create full applicant","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"(441) 111-1111\",\n \"external_id\": \"123111123124\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"expected_empstartdate\": \"2023-06-20\",\n \"send_sms\": true,\n \"cost_center_id\": \"b4f23666-6805-4fa4-nceb-443f8b754gde\",\n \"department\": \"6759059bd90cf07c450965ea\",\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"number\": \"111-222-3334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [\n {\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\": \"Software Systems\",\n \"degree_name\": \"Bachelors\",\n \"degree_type\": \"Masters\",\n \"graduation_date\": \"2010-06-01\",\n \"degree_completed\": true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"employment_history\": [\n {\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"\n ]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"harmeet+10.hybrid.client@vetty.co\",\n \"relationship\": \"Manager\",\n \"otherRelationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employee_authorized_representative\",\n \"repr_email\": \"john.doe@vetty.co\",\n \"repr_phone\": \"4411111111\"\n }\n },\n \"healthcare_license\": [\n {\n \"license_code\": \"acupuncturist_license\",\n \"candidate_name\": \"John doey\",\n \"certifying_body\": \"vetty verify\",\n \"license_number\": \"DQ128h8WD\",\n \"issued_state\": \"CA\",\n \"license_issued_date\": \"mm-yyyy\",\n \"license_issued_expiry\": \"mm-yyyy\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/applicants"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770a1\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"middle_name_exists\": false,\n \"email\": \"john.doe@vetty.co\",\n \"dob\": \"1993-01-05\",\n \"ssn\": \"1231111234\",\n \"phone\": \"(441) 111-1111\",\n \"external_id\": \"123111123124\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"previous_address\": [\n {\n \"address_id\": 1,\n \"city\": \"Schenectady\",\n \"from_month\": \"12\",\n \"from_year\": \"2007\",\n \"state\": \"NY\",\n \"street\": \"Eastern Subway\",\n \"street2\": \"\",\n \"to_month\": \"10\",\n \"to_year\": \"2011\",\n \"zipcode\": \"12345\"\n }\n ],\n \"former_name\": true,\n \"expected_empstartdate\": \"2023-06-20\",\n \"send_sms\" : true,\n \"former_details\": [\n {\n \"former_id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doey\",\n \"from_month\": \"01\",\n \"from_year\": \"2005\",\n \"checkmiddlename\": false,\n \"middle_name\": \"\",\n \"to_month\": \"02\",\n \"to_year\": \"2017\"\n }\n ],\n \"driver_license\": {\n \"number\": \"111-222-3333\",\n \"state\": \"NY\"\n },\n \"additional_driver_licenses\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770b1\",\n \"number\": \"111-222-3334\",\n \"state\": \"NY\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\"\n }\n ],\n \"education_history\": [{\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770c1\",\n \"school_name\": \"NY degree colage\",\n \"degree\": {\n \"major\":\"Software Systems\",\n \"degree_name\":\"Bachelors\",\n \"degree_type\":\"Masters\",\n \"graduation_date\":\"2010-06-01\",\n \"degree_completed\":true\n },\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": \"\",\n \"start_date\": \"2008-02-14\",\n \"end_date\": \"2011-08-11\",\n \"gpa\": \"4.0\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }],\n \"employment_history\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770d1\",\n \"name_of_employer\": \"Vetty\",\n \"job_title\": \"Software Developer\",\n \"start_date\": \"2017-01-01\",\n \"end_date\": \"2019-12-31\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"county\": \"New York\",\n \"zipcode\": \"10011\",\n \"country\": \"USA\"\n },\n \"fax\": \"1234324\",\n \"current_employer\": true,\n \"self_employed\": false,\n \"permission_to_contact\": true\n }\n ],\n \"licenses\": [\n {\n \"id\": \"93b5e486-32ab-4f32-8bbd-c713c44770e1\",\n \"type\": \"license type\",\n \"number\": \"1341342134231\",\n \"expiration_date\": \"2020-01-01\",\n \"certifying_body\": \"certifying body name\",\n \"supporting_document_ids\": [\"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\", \"d4dgwhfs-4321-4ba4-aceb-443ijw354fad\"]\n }\n ],\n \"references\": [\n {\n \"name\": \"Prince\",\n \"phone\": \"4411111111\",\n \"alternate_phone\": \"4411111111\",\n \"email\": \"harmeet+10.hybrid.client@vetty.co\",\n \"relationship\": \"Manager\",\n \"otherRelationship\": \"\",\n \"address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zipcode\": \"10011\"\n }\n }\n ],\n \"i9form_details\": {\n \"verification\": {\n \"verification_mode\": \"employee_authorized_representative\",\n \"repr_email\": \"john.doe@vetty.co\",\n \"repr_phone\": \"4411111111\"\n }\n },\n \"healthcare_license\": [\n {\n \"license_code\": \"acupuncturist_license\",\n \"candidate_name\": \"John doey\",\n \"certifying_body\": \"vetty verify\",\n \"license_number\": \"DQ128h8WD\",\n \"issued_state\": \"CA\",\n \"license_issued_date\": \"mm-yyyy\",\n \"license_issued_expiry\": \"mm-yyyy\",\n \"supporting_document_ids\": [\n \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\"\n ]\n }\n ],\n \"cost_center_id\" : \"b4f23666-6805-4fa4-nceb-443f8b754gde\",\n \"department\": \"6759059bd90cf07c450965ea\"\n}"}],"_postman_id":"4ba4e602-259e-4d8f-9692-eb2b5183228b"},{"name":"Archive Applicant","id":"6c2bd452-a44d-4026-b414-1241a92f7375","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"archived\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/applicants/{applicant_id}?archive=true","description":"

Archive an applicant

An applicant is the individual on who the check is being performed. To initiate a check an applicant must first be created. Applicants can be retrieved and listed.

Please Note: if the package has I9 verification or healthcare licenses and certifications verification there may be additional information that has to be provided in the payload before the screening is started. Please check I9 workflows from the example dropdown for more details.

\n","event":[{"listen":"prerequest","script":{"id":"a8c5ac20-64ea-43b4-b030-27e3fcc0cda9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"61c6ac77-a67b-4cd8-a976-c37f3834155d","type":"text/javascript","exec":[""]}}],"_postman_id":"3704e2f5-c1fe-4a0b-bdb9-2c03c84ed392","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}}},{"name":"Document","item":[{"name":"Upload applicant document","id":"47530142-9286-45df-b7f6-5d056e107068","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"disclosure\",\n \"content_type\": \"application/pdf\",\n \"content\": \"base64 encoded string\",\n \"filename\": \"disclosure.pdf\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/applicants/{applicant_id}/documents","description":"

Upload document

Get metadata about the document. Use the download_url to retrieve the actual document.

\n","urlObject":{"path":["cfapi","v1","applicants","{applicant_id}","documents","{document_id}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"46f6e021-d467-4a23-aa80-ac9ad9f99a83","name":"Retrieve an existing document","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/cfapi/v1/applicants/{applicant_id}/documents/{document_id}","host":["{{host}}"],"path":["cfapi","v1","applicants","{applicant_id}","documents","{document_id}"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"type\": \"consent\",\n \"created_at\": \"2020-07-11T20:10:230Z\",\n \"download_uri\": \"https://api.vetty.co/cfapi/v1/return_file?file_id=e3f2a6b6-6806-4ba4-aceb-443f8b754fac\",\n \"filesize\": 9456,\n \"filename\": \"consent.pdf\",\n \"content_type\": \"application/pdf\"\n}"}],"_postman_id":"b5d4a5b3-c30a-49ba-864f-589c87f78960"},{"name":"Get all documents","id":"b70047e1-c5ce-4095-8c4b-212b897f9ada","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/cfapi/v1/applicants/{applicant_id}/documents","description":"

Get metadata about all the documents uploaded for the applicant. Use the download_uri to retrieve the actual document.

Represents a Document related to a Applicant (such as a Driver License image, or a consent form).

Valid type of documents:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Upload Type	Document Name
disclosure	BC Disclosure
authorization	Auth Disclosure
rights_disclosure	Your Rights
disclosure_ca	CA Work Disclosure
nh_disclosure	NH MVR Disclosure
wa_disclosure	WA MVR Disclosure
pa_disclosure	PA MVR Disclosure
w9_form	W9 Form
i9form	I9 Form
insurance_policy	Insurance Policy
license_certificate	License Certification
dispute_proof	Dispute Docs
donor_pass	Health Screening Donor Pass
healthcare_license_certificate	Healthcare Licenses and Certifications
pre_adverse	Pre Adverse Custom Document
adverse	Adverse Custom Document

Some of the states require state specific disclosures, these states are Pennsylvania, Washington, California and New Hampshire.

\n","_postman_id":"03996aea-0337-43f6-af6b-aa6248358262","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}}},{"name":"Screening","item":[{"name":"Create a new screening","id":"db15a9cb-b6a9-4c88-971b-113dbc35c505","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"applicant_id\": \"60dd093bef2b6f000a60965b\",\n \"package_id\": \"5cb76e00056f7c4fa6804aab\",\n \"invite\": {\n \"method\": \"email\"\n },\n \"optional_check\": [\n {\n \"title\": \"TB Skin Test\",\n \"code\": \"tb_skin_test\"\n },\n {\n \"title\": \"Drug\",\n \"code\": \"localized_drugs\",\n \"items_included\": [\n \"panel_10_opiates\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/screenings?Authorization=your-example-key","description":"

To initiate the screening, there are three invite types: email, URL and fill_on_behalf.

For the non-invite flow, do not pass the invite method in the payload.

Optional checks are supported in the following invite types:

email
\n
url
\n
non-invite flow
\n

For the \"fill_on_behalf\" invite type, if the package includes certain checks, those same checks cannot be passed as ala carte checks.

The following checks are not supported for the \"fill_on_behalf\" invite type:

id_check
\n
i9_form
\n
covid19_tracker
\n
e_verify
\n

Invite type \"fill_on_behalf\" does not support optional checks. To include additional checks, please use alacarte checks.

If both optional checks and alacarte checks are included in a screening request, only the alacarte checks will be processed.

To set an expiry date for a donor pass, use the donor_pass_expiry key during screening. The value can range from 1 to 90 days.

Schema Update when invite method = 'fill_on_behalf'

While creating a new screening with the method = 'fill_on_behalf', the following additional keys have been included -

'scope' - Defines the number of years for which check has to be run.
\n
'previous_address' - Defines the number of previous addresses of the candidate to include as part of the check.
\n

For the 'ala_carte_check' ='Criminal County',

\"scope\": \"7\",
\"previous_address\": \"3\"

For the 'ala_carte_check' = 'State Criminal'

\"scope\": \"10\",
\"previous_address\": \"1\"

For the 'ala_carte_check' = 'County Civil',

\"scope\": \"7\",
\"previous_address\": \"1\"

Get screening status, valid status values are: in_progress, approval_needed, clear, review_required, inconclusive, error, idv_fail, archived, adverse, pending_applicant,dispute_under_review, pre_adverse, accepted, not_meet_hiring_criteria, coi_expired and inconclusive_ca

Gets a binary output of the latest screening report PDF.

To fetch the check-level report, please include the check name in the URL.

To obtain the check name associated with the applicant, use the Get Applicant Checks API.

If no check name is provided, the full report will be returned.

Gets raw JSON report of the latest screening.
\n
To fetch the check-level report, please include the check name in the URL.
\n
To obtain the check name associated with the applicant, use the Get Applicant Checks API.
\n
If no check name is provided, the full report will be returned.
\n
County Criminal check in Get JSON Report v1 API:
\n
- County Criminal check includes multiple counties(sub-order) and each county may return one or more cases.
  \n
- All cases retrieved from all county orders that are placed for the candidate’s County Criminal check are included in the 'cases' key in this API
  \n
\n

The v1 and v2 versions of the Get JSON Report API are identical except for the below change in JSON schema for the County Criminal Check in Get JSON Report v2 API:

County Criminal check includes multiple counties(sub-order) and each county may return one or more cases.
\n
In the v2 version of the Get JSON report API, details associated with each county(sub-order) are stored in the ‘search_details’ key
\n
Each object in the ‘search_details’ key returns the county-specific details such as search details and all cases in that county.
\n

Note: v2 version of the Get JSON Report API is only supported for applicants created after 9/18/2024

For criminal checks such as national, state, and county criminal searches, you need to specify the aliases key with the value \"yes\" or \"no\" under the options section. The count of aliases to be run is specified with the key \"count\" and can have supported values of 3, 10, or All.

To specify the number of verifications for education, employment, and reference checks, add the \"verification_count\" key under the options section. The supported values for this key are 1, 2, and 3.

A screening is a background check on an application with a specific package. A screening consists of multiple reports based on the selected package. After a screening is created you can get the status of the screening by calling the GET /v1/sreenings/{screening_id} endpoint.

\n","_postman_id":"d85dd669-4ea9-4d5c-aae2-935b71f28b1a","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}}},{"name":"Package","item":[{"name":"Retrive a package","id":"c1b5cc09-12c7-43db-a37c-30fbbd0646be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/cfapi/v1/packages/{package_id}?location=","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}},"urlObject":{"path":["cfapi","v1","packages","{package_id}"],"host":["{{host}}"],"query":[{"key":"location","value":""}],"variable":[]}},"response":[{"id":"f4045d87-102d-4783-8218-adb2be0feb10","name":"Retrive a package","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/cfapi/v1/packages/{package_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"76b5eby6-32ab-4f32-8b4g-c713c52770b3\",\n \"name\": \"simple checks\",\n \"price\": 67,\n \"renewal_cost_per_year\": \"3\",\n \"checks\" : [\n {\n \"name\": \"SSN Trace\",\n \"code\": \"ssntrace\"\n },\n {\n \"name\": \"National Criminal\",\n \"code\": \"nationalcrim\"\n }\n ],\n \"renewals\": [\n {\n \"name\": \"SSN Trace\",\n \"code\": \"ssntrace\",\n \"frequency\": 30\n },\n {\n \"name\": \"National Criminal\",\n \"code\": \"nationalcrim\",\n \"frequency\": 30\n }\n ],\n \"onboarding_docs\" : [\n {\n \"name\" : \"W9 Form\",\n \"code\": \"w9_form\",\n \"order\": 1\n },\n {\n \"name\" : \"Paintzen Service Agreement\",\n \"code\": \"service_agreement\",\n \"order\": 2\n }\n ]\n}"},{"id":"26370595-dab2-49c6-97de-dd9e1b5193a8","name":"Retrive a package with location","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/cfapi/v1/packages/{package_id}?location=76b5eby6-32ab-4f32-8b4g-c713c52770b3","host":["{{host}}"],"path":["cfapi","v1","packages","{package_id}"],"query":[{"key":"location","value":"76b5eby6-32ab-4f32-8b4g-c713c52770b3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"76b5eby6-32ab-4f32-8b4g-c713c52770b3\",\n \"name\": \"simple checks\",\n \"price\": 67,\n \"renewal_cost_per_year\": \"3\",\n \"checks\" : [\n {\n \"name\": \"SSN Trace\",\n \"code\": \"ssntrace\"\n },\n {\n \"name\": \"National Criminal\",\n \"code\": \"nationalcrim\"\n }\n ],\n \"renewals\": [\n {\n \"name\": \"SSN Trace\",\n \"code\": \"ssntrace\",\n \"frequency\": 30\n },\n {\n \"name\": \"National Criminal\",\n \"code\": \"nationalcrim\",\n \"frequency\": 30\n }\n ],\n \"onboarding_docs\" : [\n {\n \"name\" : \"W9 Form\",\n \"code\": \"w9_form\",\n \"order\": 1\n },\n {\n \"name\" : \"Paintzen Service Agreement\",\n \"code\": \"service_agreement\",\n \"order\": 2\n }\n ]\n}"},{"id":"ec0397af-e36e-4a50-8d64-dbea7ee0b2c7","name":"Retrive a package with optional check","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/cfapi/v1/packages/{package_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"76b5eby6-32ab-4f32-8b4g-c713c52770b3\",\n \"name\": \"simple checks\",\n \"price\": 67,\n \"renewal_cost_per_year\": \"3\",\n \"checks\": [\n {\n \"name\": \"SSN Trace\",\n \"code\": \"ssntrace\"\n },\n {\n \"name\": \"National Criminal\",\n \"code\": \"nationalcrim\"\n }\n ],\n \"optional_health_checks\": [\n {\n \"name\": \"TB Skin Test\",\n \"code\": \"tb_skin_test\",\n \"is_checked\": true,\n \"is_disabled\": false\n },\n {\n \"name\": \"Drug\",\n \"code\": \"localized_drugs\",\n \"is_checked\": true,\n \"is_disabled\": false,\n \"option_check\": [\n {\n \"name\": \"10 Panel Drug + Expanded Opiates\",\n \"code\": \"panel_10_opiates\",\n \"is_checked\": true\n },\n {\n \"name\": \"10 Panel Drug + Alcohol\",\n \"code\": \"panel_10_alcohol\",\n \"is_checked\": true\n },\n {\n \"name\": \"10 Panel Drug\",\n \"code\": \"panel_10\",\n \"is_checked\": true\n },\n {\n \"name\": \"10 Panel + Buprenorphine+MDMA & Oxy\",\n \"code\": \"panel_10_Oxy_BuprenorphineMDMA_\",\n \"is_checked\": true\n }\n ]\n },\n {\n \"name\": \"Basic Physical\",\n \"code\": \"basic_physical\",\n \"is_checked\": true,\n \"is_disabled\": false\n },\n {\n \"name\": \"Titers\",\n \"code\": \"ohs_titers\",\n \"is_checked\": true,\n \"is_disabled\": false,\n \"option_check\": [\n {\n \"name\": \"Blood Draw Collection\",\n \"code\": \"blood_draw_collection\",\n \"is_checked\": true,\n \"is_hidden\": false\n },\n {\n \"name\": \"Hepatitis B Surface AntiBody, Quantitative\",\n \"code\": \"hepatitis_b_titer\",\n \"is_checked\": true,\n \"is_hidden\": false\n },\n {\n \"name\": \"Hepatitis B Core Antibody, Total\",\n \"code\": \"hep_b_cat\",\n \"is_checked\": true,\n \"is_hidden\": false\n }\n ]\n }\n ],\n \"renewals\": [\n {\n \"name\": \"SSN Trace\",\n \"code\": \"ssntrace\",\n \"frequency\": 30\n },\n {\n \"name\": \"National Criminal\",\n \"code\": \"nationalcrim\",\n \"frequency\": 30\n }\n ],\n \"onboarding_docs\": [\n {\n \"name\": \"W9 Form\",\n \"code\": \"w9_form\",\n \"order\": 1\n },\n {\n \"name\": \"Paintzen Service Agreement\",\n \"code\": \"service_agreement\",\n \"order\": 2\n }\n ]\n}"}],"_postman_id":"c1b5cc09-12c7-43db-a37c-30fbbd0646be"},{"name":"Get all packages","id":"9ab19d2b-96a9-4b59-be1c-ef034370a9c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/cfapi/v1/packages?location=","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}},"urlObject":{"path":["cfapi","v1","packages"],"host":["{{host}}"],"query":[{"key":"location","value":""}],"variable":[]}},"response":[{"id":"3e63d753-46d0-41f4-b1fc-32450b990c36","name":"Get all packages","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/cfapi/v1/packages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"76b5eby6-32ab-4f32-8b4g-c713c52770b3\",\n \"name\": \"simple checks\",\n \"price\": 67,\n \"renewal_cost_per_year\": \"3\",\n \"checks\" : [\n {\n \"name\": \"SSN Trace\",\n \"code\": \"ssntrace\"\n },\n {\n \"name\": \"National Criminal\",\n \"code\": \"nationalcrim\"\n }\n ],\n \"renewals\": [\n {\n \"name\": \"SSN Trace\",\n \"code\": \"ssntrace\",\n \"frequency\": 30\n },\n {\n \"name\": \"National Criminal\",\n \"code\": \"nationalcrim\",\n \"frequency\": 30\n }\n ],\n \"extra_docs\" : [\n {\n \"name\" : \"W9 Form\",\n \"code\": \"w9_form\",\n \"order\": 1\n },\n {\n \"name\" : \"Paintzen Service Agreement\",\n \"code\": \"service_agreement\",\n \"order\": 2\n }\n ]\n }\n]"},{"id":"82c85891-c337-4d37-8634-0f1a6935f467","name":"Get all packages with location","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/cfapi/v1/packages?location=76b5eby6-32ab-4f32-8b4g-c713c52770b3","host":["{{host}}"],"path":["cfapi","v1","packages"],"query":[{"key":"location","value":"76b5eby6-32ab-4f32-8b4g-c713c52770b3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"76b5eby6-32ab-4f32-8b4g-c713c52770b3\",\n \"name\": \"simple checks\",\n \"price\": 67,\n \"renewal_cost_per_year\": \"3\",\n \"checks\" : [\n {\n \"name\": \"SSN Trace\",\n \"code\": \"ssntrace\"\n },\n {\n \"name\": \"National Criminal\",\n \"code\": \"nationalcrim\"\n }\n ],\n \"renewals\": [\n {\n \"name\": \"SSN Trace\",\n \"code\": \"ssntrace\",\n \"frequency\": 30\n },\n {\n \"name\": \"National Criminal\",\n \"code\": \"nationalcrim\",\n \"frequency\": 30\n }\n ],\n \"extra_docs\" : [\n {\n \"name\" : \"W9 Form\",\n \"code\": \"w9_form\",\n \"order\": 1\n },\n {\n \"name\" : \"Paintzen Service Agreement\",\n \"code\": \"service_agreement\",\n \"order\": 2\n }\n ]\n }\n]"}],"_postman_id":"9ab19d2b-96a9-4b59-be1c-ef034370a9c9"}],"id":"e4524244-16f7-444b-96d7-686c51f12145","_postman_id":"e4524244-16f7-444b-96d7-686c51f12145","description":"","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}}},{"name":"Cost Center","item":[{"name":"Get all cost centers","id":"84f753dd-086b-4ac2-acaa-212f3fe954d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{host}}/cfapi/v1/cost-centers","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}},"urlObject":{"path":["cfapi","v1","cost-centers"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"9d7b48ab-4e9b-4c58-b8db-d7647ab84ad3","name":"Get all cost centers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/cfapi/v1/cost-centers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"76b5eby6-32ab-4f32-8b4g-c713c52770b3\",\n \"name\": \"Operations\",\n \"parent_cost_center_id\" : null,\n \"is_leaf\" : false\n },\n {\n \"id\": \"5fb5eby6-32ab-4f32-8b4g-c713c52fyse7\",\n \"name\": \"Accounting\",\n \"parent_cost_center_id\" : \"76b5eby6-32ab-4f32-8b4g-c713c52770b3\",\n \"is_leaf\" : true\n },\n {\n \"id\": \"h375eby6-32ab-4f32-hr7s-c713c52j73fm\",\n \"name\": \"Software\",\n \"parent_cost_center_id\" : \"76b5eby6-32ab-4f32-8b4g-c713c52770b3\",\n \"is_leaf\" : true\n }\n]"}],"_postman_id":"84f753dd-086b-4ac2-acaa-212f3fe954d1"}],"id":"7b84bdc8-151f-4236-8b59-913bb9baae86","description":"

The location (cost center) attribute represents the organizational unit or category associated with an order. . Locations can be added via this API.

The department attribute represents the organizational unit or category associated with an order. By default, each order is assigned to the 'Talent Acquisition' department. Additional departments can be added via the API and assigned to orders as needed to reflect different organizational units.

\n","event":[{"listen":"prerequest","script":{"id":"530a53c9-7efa-42ef-abde-08c37f9cba94","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"28fb5c3f-0971-462f-835c-4570637326b6","type":"text/javascript","exec":[""]}}],"_postman_id":"3f31f1ce-c674-46dc-b01c-36b8df2e022a","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}}},{"name":"Adverse/Pre-adverse","item":[{"name":"Get adverse items","id":"f026bff4-d8f7-4846-bcb3-373bec5562c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{host}}/cfapi/v1/screenings/{screening_id}/adverse-items","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}},"urlObject":{"path":["cfapi","v1","screenings","{screening_id}","adverse-items"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"0f014c48-a8c5-4a89-bf74-2bdb8c66d726","name":"adverse items response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{host}}/cfapi/v1/screenings/{screening_id}/adverse-items"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n // id (event_id), case_id, check, description\n \"id\": \"86f0972f-37be-462a-8e2d-bf9e0af7a05c\", // event_id\n \"case_id\" : \"86f0972f-37be-462a-8e2d-bf9e0af7a05c\",\n \"check\" : \"MVR\",\n \"description\" : \"event description\",\n \"status\" : \"dispute\",\n \"dispute_reason\" : \"reason for dispute\",\n \"dispute_document_ids\" : [\"3416c43h-37be-6yxh-8e2d-6yxe0af7634v\"]\n }\n]"}],"_postman_id":"f026bff4-d8f7-4846-bcb3-373bec5562c3"},{"name":"Dispute","id":"ec9f025d-451f-4dce-9b54-0ac0e408af7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\" : \"86f0972f-37be-462a-8e2d-bf9e0af7a05c\",\n \"dispute_reason\" : \"reason for dispute\",\n \"dispute_document_ids\" : [\"3416c43h-37be-6yxh-8e2d-6yxe0af7634v\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/screenings/{screening_id}/adverse-items/{adverse_item_id}/dispute","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}},"urlObject":{"path":["cfapi","v1","screenings","{screening_id}","adverse-items","{adverse_item_id}","dispute"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"6b86ef75-eb87-4000-9b0a-71b4724f7194","name":"dispute response","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"dispute_reason\" : \"reason for dispute\",\n \"dispute_document_ids\" : [\"3416c43h-37be-6yxh-8e2d-6yxe0af7634v\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/screenings/{screening_id}/adverse-items/{adverse_item_id}/dispute"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"description":"","key":"Content-Type","type":"text","value":"application/json"}],"cookie":[],"responseTime":null,"body":" {\n \"id\": \"86f0972f-37be-462a-8e2d-bf9e0af7a05c\",\n \"case_id\" : \"86f0972f-37be-462a-8e2d-bf9e0af7a05c\",\n \"check\" : \"MVR\",\n \"description\" : \"event description\",\n \"status\" : \"dispute\",\n \"dispute_reason\" : \"reason for dispute\",\n \"dispute_document_ids\" : [\"3416c43h-37be-6yxh-8e2d-6yxe0af7634v\"]\n }"}],"_postman_id":"ec9f025d-451f-4dce-9b54-0ac0e408af7b"},{"name":"Pre-adverse Actions","id":"bdef73b3-8e0f-4d62-a689-70711e25d0d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"adverse_item_ids\": [\n \"86f0972f-37be-462a-8e2d-bf9e0af7a05c\"\n ],\n \"supporting_documents\": [\n \"64affc75fb301d7e0c4cfeef\",\n \"64b00112fb301d7e0c4d06d9\",\n \"64d1e9e029cce6a3f6221f68\"\n ],\n \"body\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/screenings/{screening_id}/pre-adverse-actions","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}},"urlObject":{"path":["cfapi","v1","screenings","{screening_id}","pre-adverse-actions"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"fff98493-ce8a-44ed-90c2-08e4225c1222","name":"pre-adverse actions response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"adverse_item_ids\": [\r\n \"86f0972f-37be-462a-8e2d-bf9e0af7a05c\"\r\n ],\r\n \"supporting_documents\": [\r\n \"64affc75fb301d7e0c4cfeef\",\r\n \"64b00112fb301d7e0c4d06d9\",\r\n \"64d1e9e029cce6a3f6221f68\"\r\n ],\r\n \"body\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/screenings/{screening_id}/pre-adverse-actions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"62fd0972f-37be-43as-8e2d-bf9e0af7d4hc\",\n \"adverse_item_ids\" : [\"86f0972f-37be-462a-8e2d-bf9e0af7a05c\"]\n}"}],"_postman_id":"bdef73b3-8e0f-4d62-a689-70711e25d0d4"},{"name":"Adverse Actions","id":"c7e4d133-7b5f-4c8d-9b09-a50ad0e6ba40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"supporting_documents\": [\r\n \"64affc75fb301d7e0c4cfeef\",\r\n \"64b00112fb301d7e0c4d06d9\",\r\n \"64d1e9e029cce6a3f6221f68\"\r\n ],\r\n \"body\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/screenings/{screening_id}/adverse-action","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}},"urlObject":{"path":["cfapi","v1","screenings","{screening_id}","adverse-action"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"5578993a-f49e-4073-86b9-f757ee4e46e7","name":"adverse action response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"supporting_documents\": [\r\n \"64affc75fb301d7e0c4cfeef\",\r\n \"64b00112fb301d7e0c4d06d9\",\r\n \"64d1e9e029cce6a3f6221f68\"\r\n ],\r\n \"body\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/cfapi/v1/screenings/{screening_id}/adverse-action"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"d56h0972f-65sg-d4fn-gd3f-bf9e0af7rd3f\"\n}"}],"_postman_id":"c7e4d133-7b5f-4c8d-9b09-a50ad0e6ba40"}],"id":"5909c82c-2e75-4d81-98c1-4fb84b34c313","_postman_id":"5909c82c-2e75-4d81-98c1-4fb84b34c313","description":"","auth":{"type":"bearer","bearer":{},"isInherited":true,"source":{"_postman_id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","id":"8f1a1d6b-81bf-48cc-a19f-f12fa57cc73d","name":"Vetty API","type":"collection"}}},{"name":"Healthcare Licenses and Certifications","item":[{"name":"Get Healthcare License List","id":"4f10ea18-cbde-4c78-becb-b077620717d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer {{access_token}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{host}}/cfapi/v1/client/get_allowed_licenses","description":"

Healthcare licenses list shows all the allocated licenses for your clients account on Vetty. If no licenses returned please contact Vetty support.