WOTC API

api.json

{"openapi":"3.0.0","info":{"title":"WOTC API","description":"Automate the process of collecting and managing new hire documentation to increase compliance, accuracy and efficiency. You can find out more about WOTC at [https:\/\/tcservicesusa.com\/](https:\/\/tcservicesusa.com\/).","termsOfService":"https:\/\/tcservicesusa.com\/terms\/","contact":{"email":"[email protected]"},"license":{"name":"Apache 2.0","url":"http:\/\/www.apache.org\/licenses\/LICENSE-2.0.html"},"version":"1.0.0"},"servers":[{"url":"https:\/\/wotc.com\/portal\/api\/v1","description":"API End Point"}],"paths":{"\/applicants":{"get":{"tags":["applicant"],"summary":"Get as list of applicants","operationId":"getApplicant","parameters":[{"name":"page","in":"query","description":"The page number","schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"The the number of items return per page","schema":{"type":"integer"}}],"responses":{"200":{"description":"list of applicants"}}},"put":{"tags":["applicant"],"summary":"Create or update an applicant","operationId":"getApplicants","requestBody":{"request":"Applicant","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/Applicant"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Applicant"}}}},"responses":{"200":{"description":"Successful in creating an applicant"},"400":{"description":"Validation error"}}},"post":{"tags":["applicant"],"summary":"Create an applicant","operationId":"getApplicants","requestBody":{"request":"Applicant","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/Applicant"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Applicant"}}}},"responses":{"200":{"description":"Successful in creating an applicant"},"400":{"description":"Validation error"}}}},"\/applicants\/email-link":{"post":{"tags":["applicant"],"summary":"Mass email provided applicant IDs their WOTC link","operationId":"applicantEmailLink","requestBody":{"request":"Applicant","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"properties":{"applicants":{"description":"List of IDs of applicants","type":"array","items":{"description":"ID of applicants","type":"int64","example":22334}},"msg":{"description":"Custom message to applicant","type":"string","example":"Please fill out the form in the link below"}},"type":"object"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Applicant"}}}},"responses":{"204":{"description":"Successful in emailing applicants"},"400":{"description":"Validation error"}}}},"\/applicants\/sms-link":{"post":{"tags":["applicant"],"summary":"Mass text message provided applicant IDs their WOTC link","operationId":"applicantSmsLink","requestBody":{"request":"Applicant","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"properties":{"applicants":{"description":"List of IDs of applicants","type":"array","items":{"description":"ID of applicants","type":"int64","example":22334}},"msg":{"description":"Custom message to applicant","type":"string","example":"Please fill out the form in the link below"}},"type":"object"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Applicant"}}}},"responses":{"200":{"description":"Successful in emailing applicants"},"400":{"description":"Validation error"}}}},"\/applicants\/{applicantId}":{"put":{"tags":["applicant"],"summary":"Update information about the applicant","operationId":"updateApplicant","parameters":[{"name":"applicantId","in":"path","description":"ID of applicant to update","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"request":"Applicant","description":"Any of these fields can be updated none are required.","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/ApplicantUpdate"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ApplicantUpdate"}}}},"responses":{"200":{"description":"Successful in updating the applicant","content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/ApplicantUpdate"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Applicant"}}}},"400":{"description":"Validation error"},"403":{"description":"You are not authorized to update this applicant"}}},"delete":{"tags":["applicant"],"summary":"Delete an applicant","operationId":"deleteApplicant","parameters":[{"name":"applicantId","in":"path","description":"ID of applicant to delete","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful in deleting the applicant"},"400":{"description":"Validation error"}}}},"\/applicants\/changes\/wotc\/status":{"get":{"tags":["applicant"],"summary":"Get as of applicants whos WOTC status has changed in the last 24 hours.","operationId":"wotcChanges","parameters":[{"name":"company_id","in":"query","description":"Limit the results to a single company, if not all companies within authorized list is used.","schema":{"type":"int64","example":"12334"}},{"name":"start_date","in":"query","description":"Limit results to anytime on or after the start date is provided","schema":{"type":"date","example":"12\/21\/2019"}},{"name":"end_date","in":"query","description":"Limit results to anytime on or before the end date is provided","schema":{"type":"date","example":"12\/22\/2019"}},{"name":"status","in":"query","description":"Filter to only employees changed to this status.","schema":{"type":"enum","enum":["Incomplete","New","Pending","Pre-Qualified","Certified","Denied","Info Needed","Credit Processed"],"example":"Pending"}}],"responses":{"200":{"description":"List of WOTC status changes.","content":{"application\/json":{"schema":{"items":{"$ref":"#\/components\/schemas\/AuditWotcStatus"}}}}}}}},"\/company\/settings":{"get":{"tags":["company"],"summary":"Get company settings, if there are no settings saved, an empty response if given.","operationId":"companyGetSettings","parameters":[{"name":"company_id","in":"query","description":"(Optional) The company id to update settings from. This is not required, only used if a partner account wanting to update a sub-company.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful in getting company settings","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CompanySettings"}}}}}},"put":{"tags":["company"],"summary":"Update company settings","operationId":"companyUpdateSettings","parameters":[{"name":"company_id","in":"query","description":"(Optional) The company id to update settings from. This is not required, only used if a partner account wanting to update a sub-company.","schema":{"type":"integer"}}],"requestBody":{"request":"Company","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/CompanySettings"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CompanySettings"}}}},"responses":{"204":{"description":"Successful in updating company settings"},"400":{"description":"Validation error"}}}},"\/documents\/upload":{"post":{"tags":["document"],"summary":"Upload a document, then get back the document to continue changes","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\DocumentController::upload","requestBody":{"description":"Upload document request body","content":{"application\/octet-stream":{"schema":{"type":"string","format":"binary"}},"application\/json":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Successful in uploading the document"},"400":{"description":"Validation error"},"422":{"description":"Document type is not supported"}}}},"\/documents\/{id}":{"put":{"tags":["document"],"summary":"Update a document","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\DocumentController::update","parameters":[{"name":"id","in":"path","description":"ID of the document to update","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"request":"Document","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/Document"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Document"}}}},"responses":{"200":{"description":"Successful in updating the document"},"400":{"description":"Validation error"}}}},"\/documents":{"get":{"tags":["document"],"summary":"Get as list of documents","parameters":[{"name":"page","in":"query","description":"The page number","schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"The the number of items return per page","schema":{"type":"integer"}}],"responses":{"200":{"description":"list of documents","content":{"application\/json":{"schema":{"properties":{"current_page":{"title":"Current Page","description":"Page position of pagination","format":"int32","items":{"type":"int32","example":"1"}},"data":{"title":"Documents","description":"List of documents","type":"array","items":{"$ref":"#\/components\/schemas\/Document"}},"first_page_url":{"title":"First Page URL","description":"URL to query first page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"from":{"title":"From","description":"Start position","format":"int32","items":{"type":"int32","example":"1"}},"last_page":{"title":"Last Page","description":"Total number of pages","format":"int32","items":{"type":"int32","example":"1"}},"last_page_url":{"title":"Last Page URL","description":"URL to query the last page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"next_page_url":{"title":"Next Page URL","description":"URL to query the next page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"path":{"title":"Path","description":"URL to the page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"per_page":{"title":"Per Page","description":"Total of documents per page","format":"int32","items":{"type":"int32","example":"50"}},"prev_page_url":{"title":"Previous Page URL","description":"URL to query the previous page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"to":{"title":"To","description":"Page end position of pagination","format":"int32","items":{"type":"int32","example":"1"}},"total":{"title":"Total","description":"Total number of items","format":"int32","items":{"type":"int32","example":"10"}}},"type":"object"}}}}}}},"\/employees\/{employeeId}":{"get":{"tags":["employee"],"summary":"Fetch a single employee record by id","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\EmployeeController::one","parameters":[{"name":"employeeId","in":"path","description":"ID of the employee to fetch","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful in updating the applicant","content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/Employee"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Employee"}}}}}},"put":{"tags":["employee"],"summary":"Update an employee","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\EmployeeController::update","parameters":[{"name":"employeeId","in":"path","description":"ID of employee to update","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"request":"Employee","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/EmployeeUpdate"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EmployeeUpdate"}}}},"responses":{"200":{"description":"Successful in creating an employee"},"400":{"description":"Validation error"}}}},"\/employees":{"get":{"tags":["employee"],"summary":"Get as list of employees","operationId":"getEmployees","parameters":[{"name":"page","in":"query","description":"The page number","schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"The the number of items return per page","schema":{"type":"integer"}}],"responses":{"200":{"description":"list of employees","content":{"application\/json":{"schema":{"properties":{"current_page":{"title":"Current Page","description":"Page position of pagination","format":"int32","items":{"type":"int32","example":"1"}},"data":{"title":"Employees","description":"List of employees","type":"array","items":{"$ref":"#\/components\/schemas\/Employee"}},"first_page_url":{"title":"First Page URL","description":"URL to query first page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"from":{"title":"From","description":"Start position","format":"int32","items":{"type":"int32","example":"1"}},"last_page":{"title":"Last Page","description":"Total number of pages","format":"int32","items":{"type":"int32","example":"1"}},"last_page_url":{"title":"Last Page URL","description":"URL to query the last page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"next_page_url":{"title":"Next Page URL","description":"URL to query the next page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"path":{"title":"Path","description":"URL to the page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"per_page":{"title":"Per Page","description":"Total of documents per page","format":"int32","items":{"type":"int32","example":"50"}},"prev_page_url":{"title":"Previous Page URL","description":"URL to query the previous page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"to":{"title":"To","description":"Page end position of pagination","format":"int32","items":{"type":"int32","example":"1"}},"total":{"title":"Total","description":"Total number of items","format":"int32","items":{"type":"int32","example":"10"}}},"type":"object"}}}}}},"put":{"tags":["employee"],"summary":"Create or Update an employee","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\EmployeeController::createOrUpdateOne","requestBody":{"request":"Employee","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/Employee"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Employee"}}}},"responses":{"200":{"description":"Successful in creating an employee"},"400":{"description":"Validation error"}}},"post":{"tags":["employee"],"summary":"Create an employee","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\EmployeeController::create","requestBody":{"request":"Employee","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/Employee"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Employee"}}}},"responses":{"200":{"description":"Successful in creating an employee"},"400":{"description":"Validation error"}}}},"\/employees\/{employeeId}\/wotc\/status":{"get":{"tags":["employee"],"summary":"Get employee's WOTC status","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\EmployeeController::wotcStatus","parameters":[{"name":"employeeId","in":"path","description":"ID of employee to get the WOTC status from","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"WOTC status of employee","content":{"application\/json":{"schema":{"properties":{"status":{"description":"Status of employee","type":"enum","enum":["Not Submitted","New","Pending","Pre-Qualified","Certified","Denied","Info\n     *                     Needed","Credit Processed"]}},"type":"object"}}}},"400":{"description":"Unable to find employee"}}}},"\/employees\/{employeeId}\/wotc":{"get":{"tags":["employee"],"summary":"Fetch wotc specific information for employee","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\EmployeeController::wotc","parameters":[{"name":"employeeId","in":"path","description":"ID of the employee to fetch","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Employee WOTC details","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EmployeeWotc"}}}}}}},"\/employees\/wotc\/certified":{"get":{"tags":["employee"],"summary":"Get employees with certified WOTC status","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\EmployeeController::certified","parameters":[{"name":"company_id","in":"path","description":"ID of comapny to get the WOTC status from, if none is provided, user's allowed list of\n     *         companies is provided","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"List of employee that are certified and when they were certified","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/EmployeeCertified"}}}}}}}},"\/employees\/lookup":{"post":{"tags":["employee"],"summary":"Find an employee record","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\EmployeeController::lookup","parameters":[{"name":"company_id","in":"path","description":"ID of comapny to get the employee record from, if none is provided, user's primary company\n     *         is used","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"first_name","in":"path","description":"First name of employee","required":false,"schema":{"type":"string","example":"John"}},{"name":"last_name","in":"path","description":"Last name of employee","required":false,"schema":{"type":"string","example":"Doe"}},{"name":"email","in":"path","description":"Email of employee","required":false,"schema":{"type":"string","example":"[email protected]"}},{"name":"dob","in":"path","description":"Date of birth of employee","required":false,"schema":{"type":"string","example":"1980-11-12"}},{"name":"phone","in":"path","description":"Phone number of employee","required":false,"schema":{"type":"string","example":"6192231211"}}],"responses":{"200":{"description":"List of employee that are certified and when they were certified","content":{"application\/json":{"schema":{"items":{"$ref":"#\/components\/schemas\/Employee"}}}}}}}},"\/hours-wages":{"get":{"tags":["payroll"],"summary":"Get as list of hours and wages","parameters":[{"name":"page","in":"query","description":"The page number","schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"The the number of items return per page","schema":{"type":"integer"}}],"responses":{"200":{"description":"list of employee payrolls","content":{"application\/json":{"schema":{"properties":{"current_page":{"title":"Current Page","description":"Page position of pagination","format":"int32","items":{"type":"int32","example":"1"}},"data":{"title":"Documents","description":"List of documents","type":"array","items":{"$ref":"#\/components\/schemas\/Payroll"}},"first_page_url":{"title":"First Page URL","description":"URL to query first page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"from":{"title":"From","description":"Start position","format":"int32","items":{"type":"int32","example":"1"}},"last_page":{"title":"Last Page","description":"Total number of pages","format":"int32","items":{"type":"int32","example":"1"}},"last_page_url":{"title":"Last Page URL","description":"URL to query the last page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"next_page_url":{"title":"Next Page URL","description":"URL to query the next page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"path":{"title":"Path","description":"URL to the page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"per_page":{"title":"Per Page","description":"Total of documents per page","format":"int32","items":{"type":"int32","example":"50"}},"prev_page_url":{"title":"Previous Page URL","description":"URL to query the previous page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"to":{"title":"To","description":"Page end position of pagination","format":"int32","items":{"type":"int32","example":"1"}},"total":{"title":"Total","description":"Total number of items","format":"int32","items":{"type":"int32","example":"10"}}},"type":"object"}}}}}},"post":{"tags":["payroll"],"summary":"Add a payroll record","operationId":"addPayroll","requestBody":{"request":"Payroll","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/Payroll"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Payroll"}}}},"responses":{"200":{"description":"Successful in adding the payroll to employee record"},"400":{"description":"Validation error"}}}},"\/employees\/{employeeId}\/hours-wages":{"get":{"tags":["payroll"],"summary":"Get as list of hours and wages by employee record","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\HoursWagesController::listByEmployee","parameters":[{"name":"page","in":"query","description":"The page number","schema":{"type":"integer"}},{"name":"per_page","in":"query","description":"The the number of items return per page","schema":{"type":"integer"}},{"name":"employee_id","in":"query","description":"The employee record ID","schema":{"type":"integer"}}],"responses":{"200":{"description":"list of hours and wages by employee","content":{"application\/json":{"schema":{"properties":{"current_page":{"title":"Current Page","description":"Page position of pagination","format":"int32","items":{"type":"int32","example":"1"}},"data":{"title":"Documents","description":"List of documents","type":"array","items":{"$ref":"#\/components\/schemas\/Payroll"}},"first_page_url":{"title":"First Page URL","description":"URL to query first page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"from":{"title":"From","description":"Start position","format":"int32","items":{"type":"int32","example":"1"}},"last_page":{"title":"Last Page","description":"Total number of pages","format":"int32","items":{"type":"int32","example":"1"}},"last_page_url":{"title":"Last Page URL","description":"URL to query the last page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"next_page_url":{"title":"Next Page URL","description":"URL to query the next page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"path":{"title":"Path","description":"URL to the page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"per_page":{"title":"Per Page","description":"Total of documents per page","format":"int32","items":{"type":"int32","example":"50"}},"prev_page_url":{"title":"Previous Page URL","description":"URL to query the previous page","format":"string","items":{"type":"string","example":"https:\/\/wotc.com\/portal\/api\/v1\/documents?page=1"}},"to":{"title":"To","description":"Page end position of pagination","format":"int32","items":{"type":"int32","example":"1"}},"total":{"title":"Total","description":"Total number of items","format":"int32","items":{"type":"int32","example":"10"}}},"type":"object"}}}}}}},"\/hours-wages\/{id}":{"put":{"tags":["payroll"],"summary":"Update a payroll record","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\HoursWagesController::update","parameters":[{"name":"id","in":"path","description":"ID of the payroll to update","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"request":"Document","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/Payroll"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Payroll"}}}},"responses":{"200":{"description":"Successful in updating the document"},"400":{"description":"Validation error"}}}},"\/hours-wages\/submit":{"post":{"tags":["payroll"],"summary":"Submit all hours and wages for review","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\HoursWagesController::submit","parameters":[{"name":"company_id","in":"query","description":"(optional) The company to submit hours and wages from. If provided the user is checked to ensure they can access that company.","required":false,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Submitting payroll is successful","content":{"application\/x-www-form-urlencoded":{"schema":{"type":"object","format":"binary"}},"application\/json":{"schema":{"type":"object","format":"binary"}}}},"responses":{"204":{"description":"Successful in submitting, no content"},"400":{"description":"Validation error"}}}},"\/hours-wages\/bulk":{"put":{"tags":["payroll"],"operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\HoursWagesController::bulk","requestBody":{"description":"Submitting payroll is successful","content":{"application\/x-www-form-urlencoded":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/PayrollBulk"}}},"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/PayrollBulk"}}}}},"responses":{"200":{"description":"list of hours and wages by employee","content":{"application\/json":{"schema":{"items":{"$ref":"#\/components\/schemas\/PayrollBulkResultSet"}}}}},"400":{"description":"Validation error"}}}},"\/locations":{"get":{"tags":["location"],"summary":"Get as list of locations","operationId":"getLocation","responses":{"200":{"description":"list of locations"}}},"put":{"tags":["location"],"summary":"Update a location","operationId":"updateLocation","requestBody":{"request":"Location","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"title":"Location model","description":"Location model","properties":{"location":{"$ref":"#\/components\/schemas\/Location"}},"type":"object"}},"application\/json":{"schema":{"title":"Location model","description":"Location model","properties":{"location":{"$ref":"#\/components\/schemas\/Location"}},"type":"object"}}}},"responses":{"200":{"description":"Successful in updating a location"},"400":{"description":"Validation error"}}},"post":{"tags":["location"],"summary":"Create a new location","operationId":"addLocation","requestBody":{"request":"Applicant","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/Location"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Location"}}}},"responses":{"200":{"description":"Successful in creating a location"},"400":{"description":"Validation error"}}}},"\/locations\/{locationId}":{"delete":{"tags":["location"],"summary":"Delete a location","operationId":"deleteLocation","parameters":[{"name":"locationId","in":"path","description":"ID of location to delete","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Successful in deleting the applicant"},"400":{"description":"Validation error"}}}},"\/register":{"post":{"tags":["register"],"summary":"Register for an account and get back a life time access token","operationId":"register","requestBody":{"request":"Company","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/Register"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Register"}}}},"responses":{"201":{"description":"Successful in registering an account","content":{"application\/json":{"schema":{"properties":{"token":{"title":"Access Token","description":"The token provided here is the life time access token","format":"string","example":"eyJ0eXAiOiJKV1QiLCJhb..."},"user":{"$ref":"#\/components\/schemas\/User"},"company":{"$ref":"#\/components\/schemas\/Company"},"wotc_url":{"title":"WOTC URL","description":"The URL to register employees and applicants","format":"string","example":"https:\/\/sandbox.wotc.com\/portal\/company-url\/f8850"}},"type":"object"}}}},"400":{"description":"Validation error"}}}},"\/sftp":{"get":{"tags":["sftp"],"summary":"Get a list of sftp accounts","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\SftpController::index","responses":{"200":{"description":"list of paginated sftp accounts","content":{"application\/json":{"schema":{"properties":{"current_page":{"title":"Current Page","description":"Page position of pagination","format":"int32","items":{"type":"int32","example":"1"}},"data":{"title":"Sftps","description":"List of sftp account","type":"array","items":{"$ref":"#\/components\/schemas\/Sftp"}},"first_page_url":{"title":"First Page URL","description":"URL to query first page","format":"string","items":{"type":"string","example":"https:\/\/example.com\/?page=1"}},"from":{"title":"From","description":"Start position","format":"int32","items":{"type":"int32","example":"1"}},"last_page":{"title":"Last Page","description":"Total number of pages","format":"int32","items":{"type":"int32","example":"1"}},"last_page_url":{"title":"Last Page URL","description":"URL to query the last page","format":"string","items":{"type":"string","example":"https:\/\/example.com\/?page=1"}},"next_page_url":{"title":"Next Page URL","description":"URL to query the next page","format":"string","items":{"type":"string","example":"https:\/\/example.com\/?page=1"}},"path":{"title":"Path","description":"URL to the page","format":"string","items":{"type":"string","example":"https:\/\/example.com\/?page=1"}},"per_page":{"title":"Per Page","description":"Total of results per page","format":"int32","items":{"type":"int32","example":"50"}},"prev_page_url":{"title":"Previous Page URL","description":"URL to query the previous page","format":"string","items":{"type":"string","example":"https:\/\/example.com\/?page=1"}},"to":{"title":"To","description":"Page end position of pagination","format":"int32","items":{"type":"int32","example":"1"}},"total":{"title":"Total","description":"Total number of items","format":"int32","items":{"type":"int32","example":"10"}}},"type":"object"}}}},"500":{"description":"Server Error"}}}},"\/sftps":{"post":{"tags":["sftp"],"summary":"Create a sftp","operationId":"createSftp","requestBody":{"request":"Sftp","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/SftpCreate"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SftpCreate"}}}},"responses":{"200":{"description":"Successful in creating a sftp","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Sftp"}}}},"400":{"description":"Validation error"}}}},"\/sftps\/{sftpId}":{"put":{"tags":["sftp"],"summary":"Update a sftp","operationId":"updateSftp","parameters":[{"name":"sftpId","in":"path","description":"ID of sftp to update","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"request":"Sftp","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/SftpUpdate"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SftpUpdate"}}}},"responses":{"200":{"description":"Successful in updating a sftp","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Sftp"}}}},"400":{"description":"Validation error"}}},"delete":{"tags":["sftp"],"summary":"Delete a sftp account","operationId":"deleteSftp","parameters":[{"name":"sftpId","in":"path","description":"ID of sftp account to update","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful in deleting a sftp account"},"400":{"description":"Validation error"},"403":{"description":"Permission error"},"500":{"description":"Server error"}}}},"\/webhooks":{"get":{"tags":["webhook"],"summary":"Get a list of webhooks","operationId":"App\\Http\\Controllers\\Api\\V1\\Client\\WebhookController::index","responses":{"200":{"description":"list of paginated webhooks","content":{"application\/json":{"schema":{"properties":{"current_page":{"title":"Current Page","description":"Page position of pagination","format":"int32","items":{"type":"int32","example":"1"}},"data":{"title":"Webhooks","description":"List of webhooks","type":"array","items":{"$ref":"#\/components\/schemas\/Webhook"}},"first_page_url":{"title":"First Page URL","description":"URL to query first page","format":"string","items":{"type":"string","example":"https:\/\/example.com\/?page=1"}},"from":{"title":"From","description":"Start position","format":"int32","items":{"type":"int32","example":"1"}},"last_page":{"title":"Last Page","description":"Total number of pages","format":"int32","items":{"type":"int32","example":"1"}},"last_page_url":{"title":"Last Page URL","description":"URL to query the last page","format":"string","items":{"type":"string","example":"https:\/\/example.com\/?page=1"}},"next_page_url":{"title":"Next Page URL","description":"URL to query the next page","format":"string","items":{"type":"string","example":"https:\/\/example.com\/?page=1"}},"path":{"title":"Path","description":"URL to the page","format":"string","items":{"type":"string","example":"https:\/\/example.com\/?page=1"}},"per_page":{"title":"Per Page","description":"Total of results per page","format":"int32","items":{"type":"int32","example":"50"}},"prev_page_url":{"title":"Previous Page URL","description":"URL to query the previous page","format":"string","items":{"type":"string","example":"https:\/\/example.com\/?page=1"}},"to":{"title":"To","description":"Page end position of pagination","format":"int32","items":{"type":"int32","example":"1"}},"total":{"title":"Total","description":"Total number of items","format":"int32","items":{"type":"int32","example":"10"}}},"type":"object"}}}},"500":{"description":"Server Error"}}},"post":{"tags":["webhook"],"summary":"Create a webhook","operationId":"createWebhook","requestBody":{"request":"Webhook","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/WebhookCreate"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WebhookCreate"}}}},"responses":{"200":{"description":"Successful in creating a webhook","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Webhook"}}}},"400":{"description":"Validation error"}}}},"\/webhooks\/{webhookId}":{"put":{"tags":["webhook"],"summary":"Update a webhook","operationId":"updateWebhook","parameters":[{"name":"webhookId","in":"path","description":"ID of webhook to update","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"request":"Webhook","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/WebhookUpdate"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WebhookUpdate"}}}},"responses":{"200":{"description":"Successful in updating a webhook","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Webhook"}}}},"400":{"description":"Validation error"}}},"delete":{"tags":["webhook"],"summary":"Delete a webhook","operationId":"deleteWebhook","parameters":[{"name":"webhookId","in":"path","description":"ID of webhook to update","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Successful in deleting a webhook"},"400":{"description":"Validation error"},"403":{"description":"Permission error"},"500":{"description":"Server error"}}}},"\/user":{"get":{"tags":["user"],"summary":"Get authorized user information.","operationId":"userSelf","responses":{"200":{"description":"Successful in getting company settings","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/User"}}}}}}},"\/employees\/{employeeId}\/wotc\/url":{"get":{"tags":["employee","wotc"],"summary":"Generate an auto fill WOTC url","operationId":"App\\Http\\Controllers\\Api\\V1\\WotcController::generateWotcUrl","parameters":[{"name":"employeeId","in":"path","description":"ID of employee to update","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"redirect","in":"query","description":"URL to redirect to after the form is filled out","required":false,"schema":{"type":"string"}},{"name":"redirect_method","in":"query","description":"If the URL redirect should be a POST or GET, if not specificed, will redirect with POST","required":false,"schema":{"type":"enum","enum":["POST","GET"],"example":"POST"}}],"responses":{"200":{"description":"Successful in requesting the WOTC URL","content":{"application\/json":{"schema":{"properties":{"url":{"description":"Employee WOTC URL","type":"string","example":"http:\/\/google.com"}},"type":"object"}}}},"400":{"description":"Validation error"}}}},"\/wotc":{"post":{"tags":["wotc"],"summary":"Submit WOTC information for a given company","operationId":"wotc","requestBody":{"request":"Applicant","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/FormWOTC"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/FormWOTC"}}}},"responses":{"200":{"description":"Successful in submitting the WOTC data"},"400":{"description":"Validation error"}}}},"\/wotc\/calculator":{"post":{"tags":["wotc"],"summary":"Pre-qualify an application of WOTC status","operationId":"wotcCalculator","requestBody":{"request":"Applicant","required":true,"content":{"application\/x-www-form-urlencoded":{"schema":{"$ref":"#\/components\/schemas\/WotcCalculator"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/WotcCalculator"}}}},"responses":{"200":{"description":"Successful in submitting the request"},"400":{"description":"Validation error"}}}}},"components":{"schemas":{"Applicant":{"title":"Applicant model","description":"Applicant model","required":["first_name","last_name","applied_on","phone","email"],"properties":{"id":{"title":"Applicant ID","description":"The ID of the applicant","type":"int","maxLength":16,"example":"334232"},"first_name":{"title":"First Name","description":"First name","type":"string","maxLength":100,"example":"John"},"last_name":{"title":"Last Name","description":"Last name","type":"string","maxLength":100,"example":"Doe"},"email":{"title":"Email","description":"Email","type":"string","format":"email","maxLength":255},"phone":{"title":"Phone","description":"Phone number","type":"string","maxLength":60,"example":"(619) 553-2123"},"ssn":{"title":"Social Security Number","description":"The last 4 or full SSN","type":"string","maxLength":16,"example":"123-22-4421"},"dob":{"title":"Applicant Date Of Birth","description":"When the applicant was born","type":"date","maxLength":16,"example":"01\/01\/1980"},"applied_on":{"title":"Applicant Application Date","description":"When the applicant submitted their application","type":"date","maxLength":16,"example":"01\/01\/2022"},"started_on":{"title":"Applicant Hire Date","description":"When the applicant was hired","type":"date","maxLength":16,"example":"01\/01\/2022"},"address_street":{"title":"Street Address","description":"Street Address","type":"string","maxLength":255,"example":"123 Street"},"address_street2":{"title":"Street Address 2","description":"Apt #, PO Box, etc","type":"string","maxLength":100,"example":"Apt 16"},"address_city":{"title":"City","description":"City","type":"string","maxLength":100,"example":"San Diego"},"address_state":{"title":"State","description":"State","type":"string","maxLength":30,"example":"CA"},"address_county":{"title":"County","description":"County","type":"string","maxLength":100,"example":"San Diego"},"address_zipcode":{"title":"Zipcode","description":"Zipcode \/ Postal Code","type":"string","maxLength":24,"example":"92121"},"is_rehire":{"title":"Is Rehire","description":"If the applicant is a rehire","type":"boolean","example":"false"},"job_position":{"title":"Job Position","description":"What position is the applicant appling for","type":"string","maxLength":100,"example":"Sales Manager"},"starting_wage":{"title":"Starting Wage","description":"How much is the applicant going to start with","type":"number","format":"decimal","maxLength":12,"example":"Sales Manager"},"created_at":{"title":"Created At","description":"When the applicant was added","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"},"updated_at":{"title":"Updated At","description":"When the applicant was updated","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"}},"type":"object"},"ApplicantUpdate":{"title":"Applicant update model","description":"Applicant update model","properties":{"first_name":{"title":"First Name","description":"First name","type":"string","maxLength":100,"example":"John"},"last_name":{"title":"Last Name","description":"Last name","type":"string","maxLength":100,"example":"Doe"},"middle_name":{"title":"Middle Name","description":"Middle name","type":"string","maxLength":100,"example":"Jon"},"email":{"title":"Email","description":"Email","type":"string","format":"email","maxLength":255},"phone":{"title":"Phone","description":"Phone number","type":"string","maxLength":60,"example":"(619) 553-2123"},"ssn":{"title":"Social Security Number","description":"The last 4 or full SSN","type":"string","maxLength":16,"example":"123-22-4421"},"dob":{"title":"Applicant Date Of Birth","description":"When the applicant was born","type":"date","maxLength":16,"example":"01\/01\/1980"},"applied_on":{"title":"Applicant Application Date","description":"When the applicant submitted their application","type":"date","maxLength":16,"example":"01\/01\/2022"},"started_on":{"title":"Applicant Hire Date","description":"When the applicant was hired","type":"date","maxLength":16,"example":"01\/01\/2022"},"address_street":{"title":"Street Address","description":"Street Address","type":"string","maxLength":255,"example":"123 Street"},"address_street2":{"title":"Street Address 2","description":"Apt #, PO Box, etc","type":"string","maxLength":100,"example":"Apt 16"},"address_city":{"title":"City","description":"City","type":"string","maxLength":100,"example":"San Diego"},"address_state":{"title":"State","description":"State","type":"string","maxLength":30,"example":"CA"},"address_county":{"title":"County","description":"County","type":"string","maxLength":100,"example":"San Diego"},"address_zipcode":{"title":"Zipcode","description":"Zipcode \/ Postal Code","type":"string","maxLength":24,"example":"92121"}},"type":"object"},"AuditWotcStatus":{"title":"Audit WOTC Status model","description":"Audit WOTC Status model","properties":{"employee_id":{"title":"Applicant \/ Employee ID","description":"The ID of the applicant \/ employee the ID between both are the same.","type":"int64","example":"1769"},"company_id":{"title":"Company ID","description":"The ID of the company.","type":"int64","example":"11233"},"wotc_status":{"title":"WOTC Status","description":"The status of the WOTC application.","type":"enum","enum":["Incomplete","New","Pending","Pre-Qualified","Certified","Denied","Info Needed","Credit Processed"],"example":"Pending"},"wotc_status_hard":{"title":"WOTC Status - Yes \/ No","description":"The status of the WOTC application. Only use this is the integration only allows a yes or no. If the WOTC status is New or Pending, then indicators are used to determine a hard Yes or No, but that value is temporary.","type":"enum","enum":["Yes","No"],"example":"No"},"updated_at":{"title":"Updated At","description":"When the last WOTC status was updated.","type":"datetime","example":"2017-02-02 18:31:45"}},"type":"object"},"Company":{"title":"Company model","description":"Company model","required":["name","ein"],"properties":{"name":{"title":"Company Name","description":"Name of the company","type":"string","maxLength":255,"example":"Example Inc."},"label":{"title":"Compant Label","description":"The label used in the WOTC URL","type":"string","maxLength":255,"example":"example-inc"},"ein":{"title":"Employer Identification Number","description":"The employer identification number (ein) of the company","type":"string","maxLength":255,"example":"33-4333333"},"phone":{"title":"Phone","description":"Phone number","type":"string","maxLength":255,"example":"(619) 553-2123"},"address":{"title":"Company address","description":"The street address","type":"string","maxLength":255,"example":"1234 Street"},"address2":{"title":"Company address unit","description":"The unit address","type":"string","maxLength":255,"example":"PO BOX 123"},"city":{"title":"City","description":"City","type":"string","maxLength":255,"example":"San Diego"},"state":{"title":"State","description":"State","type":"string","maxLength":255,"example":"CA"},"zip":{"title":"Zipcode","description":"Zipcode","type":"string","maxLength":255,"example":"92121"},"website":{"title":"Website","description":"The website of the company","type":"string","maxLength":255,"example":"https:\/\/google.com"},"for_profit":{"title":"Is Your Company a For-Profit?","description":"The if the company for profit or a non profit","type":"boolean","example":"true"},"created_at":{"title":"Created At","description":"When the employee was added","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"},"updated_at":{"title":"Updated At","description":"When the employee was updated","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"}},"type":"object"},"CompanySettings":{"title":"Company settings model","description":"Company settings model","properties":{"mask_ssn":{"title":"Mask SSN","description":"If you should mask the social security number on the new hire form","type":"boolean","example":"0"},"form_primary_color":{"title":"Form Primary Color","description":"The color used for headers and buttons","type":"string","maxLength":24,"example":"#101010"},"form_page_bg_color":{"title":"Form Page Background Color","description":"The color of the background surrounding the page","type":"string","maxLength":24,"example":"#101010"},"form_bg_color":{"title":"Form Background Color","description":"The backgound color of the form","type":"string","maxLength":24,"example":"#101010"},"form_txt_color":{"title":"Form Text Color","description":"Color of text on form","type":"string","maxLength":24,"example":"#101010"}},"type":"object"},"Document":{"title":"Document model","description":"Document model","required":[],"properties":{"id":{"title":"Document ID","description":"ID of document","format":"int64","items":{"type":"int64","example":"12333221"}},"company_id":{"title":"Company ID","description":"ID of company, defaults to user's company ID","format":"int64","items":{"type":"int64","example":"234"}},"employee_id":{"title":"Employee ID","description":"ID of employee linked to this document","format":"int64","items":{"type":"int64","example":"234"}},"user_id":{"title":"User ID","description":"ID of user that uploaded this document","format":"int64","items":{"type":"int64","example":"12"}},"name":{"title":"Name","description":"Name of document","items":{"type":"string","example":"WOTC PDF"},"maxLength":255},"document_type":{"title":"Document Type","description":"Type of document","items":{"type":"string","example":"8850"},"enum":["Misc","8850","9061","9062","W-4","I-9","5884","Drivers License","Identification","Passport","POA","Agreement","8850 Youth Form"]},"file_type":{"title":"File Type","description":"Type of file","items":{"type":"string","example":"application\/pdf"},"maxLength":255},"file_size":{"title":"File Size","description":"Number of bytes in file","format":"int32","items":{"type":"int32","example":"12333221"}},"expiration":{"title":"Expiration Date","description":"When the document will expire, this is for informational purposes only","format":"date","items":{"type":"date","example":"2017-02-02"}},"created_at":{"title":"Created At","description":"When the document was added","format":"datetime","items":{"type":"datetime","example":"2017-02-02 18:31:45"}},"updated_at":{"title":"Updated At","description":"When the document was updated","format":"datetime","items":{"type":"datetime","example":"2017-02-02 18:31:45"}}},"type":"object"},"Employee":{"title":"Employee model","description":"Employee model","required":["first_name","last_name","ssn","started_on","dob"],"properties":{"first_name":{"title":"First Name","description":"First name","type":"string","maxLength":255,"example":"John"},"last_name":{"title":"Last Name","description":"Last name","type":"string","maxLength":255,"example":"Doe"},"email":{"title":"Email","description":"Email","type":"string","format":"email","maxLength":255},"phone":{"title":"Phone","description":"Phone number","type":"string","maxLength":60,"example":"(619) 553-2123"},"ssn":{"title":"Social Security Number","description":"The last 4 or full SSN","type":"string","maxLength":16,"example":"123-22-4421"},"started_on":{"title":"Employee Start Date","description":"When the employee started","type":"date","maxLength":16,"example":"01\/01\/2022"},"dob":{"title":"Date of Birth","description":"When was the employee born","type":"date","maxLength":16,"example":"01\/01\/1980"},"address_street":{"title":"Street Address","description":"Street Address","type":"string","maxLength":255,"example":"123 Street"},"address_street2":{"title":"Street Address 2","description":"Apt #, PO Box, etc","type":"string","maxLength":255,"example":"Apt 16"},"address_city":{"title":"City","description":"City","type":"string","maxLength":255,"example":"San Diego"},"address_state":{"title":"State","description":"State","type":"string","maxLength":255,"example":"CA"},"address_county":{"title":"County","description":"County","type":"string","maxLength":255,"example":"San Diego"},"address_zipcode":{"title":"Zipcode","description":"Zipcode \/ Postal Code","type":"string","maxLength":255,"example":"92121"},"created_at":{"title":"Created At","description":"When the employee was added","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"},"updated_at":{"title":"Updated At","description":"When the employee was updated","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"}},"type":"object"},"EmployeeUpdate":{"title":"Employee update model","description":"Employee update model","properties":{"first_name":{"title":"First Name","description":"First name","type":"string","maxLength":255,"example":"John"},"last_name":{"title":"Last Name","description":"Last name","type":"string","maxLength":255,"example":"Doe"},"email":{"title":"Email","description":"Email","type":"string","format":"email","maxLength":255},"phone":{"title":"Phone","description":"Phone number","type":"string","maxLength":60,"example":"(619) 553-2123"},"ssn":{"title":"Social Security Number","description":"The last 4 or full SSN","type":"string","maxLength":16,"example":"123-22-4421"},"started_on":{"title":"Employee Start Date","description":"When the employee started","type":"date","maxLength":16,"example":"01\/01\/2022"},"dob":{"title":"Date of Birth","description":"When was the employee born","type":"date","maxLength":16,"example":"01\/01\/1980"},"address_street":{"title":"Street Address","description":"Street Address","type":"string","maxLength":255,"example":"123 Street"},"address_street2":{"title":"Street Address 2","description":"Apt #, PO Box, etc","type":"string","maxLength":255,"example":"Apt 16"},"address_city":{"title":"City","description":"City","type":"string","maxLength":255,"example":"San Diego"},"address_state":{"title":"State","description":"State","type":"string","maxLength":255,"example":"CA"},"address_county":{"title":"County","description":"County","type":"string","maxLength":255,"example":"San Diego"},"address_zipcode":{"title":"Zipcode","description":"Zipcode \/ Postal Code","type":"string","maxLength":255,"example":"92121"},"created_at":{"title":"Created At","description":"When the employee was added","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"},"updated_at":{"title":"Updated At","description":"When the employee was updated","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"}},"type":"object"},"EmployeeCertified":{"title":"Employee Certified Model","description":"Employee certified model","properties":{"id":{"title":"employee ID","description":"The ID of the employee","type":"int","maxLength":16,"example":"334232"},"first_name":{"title":"First Name","description":"First name","type":"string","maxLength":100,"example":"John"},"last_name":{"title":"Last Name","description":"Last name","type":"string","maxLength":100,"example":"Doe"},"ssn":{"title":"Social Security Number","description":"The last 4 or full SSN","type":"string","maxLength":16,"example":"123-22-4421"},"dob":{"title":"employee Date Of Birth","description":"When the employee was born","type":"date","maxLength":16,"example":"01\/01\/1980"},"applied_on":{"title":"employee Application Date","description":"When the employee submitted their application","type":"date","maxLength":16,"example":"01\/01\/2022"},"started_on":{"title":"employee Hire Date","description":"When the employee was hired","type":"date","maxLength":16,"example":"01\/01\/2022"},"address_street":{"title":"Street Address","description":"Street Address","type":"string","maxLength":255,"example":"123 Street"},"address_street2":{"title":"Street Address 2","description":"Apt #, PO Box, etc","type":"string","maxLength":100,"example":"Apt 16"},"address_city":{"title":"City","description":"City","type":"string","maxLength":100,"example":"San Diego"},"address_state":{"title":"State","description":"State","type":"string","maxLength":30,"example":"CA"},"address_county":{"title":"County","description":"County","type":"string","maxLength":100,"example":"San Diego"},"address_zipcode":{"title":"Zipcode","description":"Zipcode \/ Postal Code","type":"string","maxLength":24,"example":"92121"},"created_at":{"title":"Created At","description":"When the employee was added","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"},"updated_at":{"title":"Updated At","description":"When the employee was updated","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"},"wotc_status":{"description":"Status of employee","type":"enum","enum":["Not Submitted","New","Pending","Pre-Qualified","Certified","Denied","Info\n *         Needed","Credit Processed"]},"certified_on":{"title":"Certified On","description":"When the employee was certified","type":"datetime","format":"datetime","example":"2020-03-12T06:31:33+00:00"}},"type":"object"},"EmployeeWotc":{"title":"Employee WOTC status and document url","description":"Employee WOTC Status","properties":{"status":{"description":"Status of employee","type":"enum","enum":["Not Submitted","New","Pending","Pre-Qualified","Certified","Denied","Info\n *         Needed","Credit Processed"]},"document_id":{"title":"Document ID","description":"ID of document","format":"int64","example":234},"document_url_expires_at":{"title":"Document Download URL Expires","description":"When the WOTC download document url expires","type":"datetime","format":"datetime","example":"2020-03-12T06:31:33+00:00"},"document_url":{"title":"Document Download URL","description":"WOTC document download url","type":"string","maxLength":1024,"example":"https:\/\/sandbox.wotc.com\/portal\/api\/v1\/documents\/tmp\/950\/f8850-4129.pdf?expires=1585866361&signature=68b7b8ae41795884732ab59537c4dcd45154c94295357585879148488b8115bb"},"submitted_on":{"title":"Submitted On","description":"When the employee filled out the WOTC document","type":"datetime","format":"datetime","example":"2020-03-12T06:31:33+00:00"},"certified_on":{"title":"Certified On","description":"When the employee was certified","type":"datetime","format":"datetime","example":"2020-03-12T06:31:33+00:00"}},"type":"object"},"FormWOTC":{"title":"WOTC Form model","description":"WOTC Form model","required":["form"],"properties":{"company_id":{"title":"Company ID","description":"The ID of the company","type":"int","maxLength":16,"example":"334232"},"location_id":{"title":"Location ID","description":"The ID of the companys location","type":"int","maxLength":16,"example":"334231"},"form":{"$ref":"#\/components\/schemas\/Wotc"}},"type":"object"},"Location":{"title":"Location model","description":"Location model","required":["name","code","phone"],"properties":{"id":{"title":"ID","description":"ID of location","type":"integer","example":"1"},"company_id":{"title":"Company ID","description":"Company ID of location","type":"integer","example":"10"},"user_id":{"title":"User ID","description":"User ID of location","type":"integer","example":"10"},"name":{"title":"Name","description":"Name of location. The name is required IF code is not provided","type":"string","maxLength":255,"example":"HR Office"},"phone":{"title":"Phone","description":"Phone number","type":"string","maxLength":60,"example":"(619) 553-2123"},"description":{"title":"Description","description":"Information about location","type":"string","maxLength":1024,"example":"HR Office on east port"},"code":{"title":"Code","description":"The code is used to provide a short-hand ID for reporting. This is required IF there no name\n *         provided","type":"string","maxLength":255,"example":"E-122"},"label":{"title":"Label","description":"The label is used to provide a custom WOTC URL","type":"string","maxLength":255,"example":"north-office"},"address_street":{"title":"Street Address","description":"Street Address","type":"string","maxLength":100,"example":"123 Street"},"address_street2":{"title":"Street Address 2","description":"Apt #, PO Box, etc","type":"string","maxLength":100,"example":"Apt 16"},"address_city":{"title":"City","description":"City","type":"string","maxLength":100,"example":"San Diego"},"address_state":{"title":"State","description":"State","type":"string","maxLength":30,"example":"CA"},"address_county":{"title":"County","description":"County","type":"string","maxLength":100,"example":"San Diego"},"address_zipcode":{"title":"Zipcode","description":"Zipcode \/ Postal Code","type":"string","maxLength":24,"example":"92121"},"created_at":{"title":"Created At","description":"When the record was added","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"},"updated_at":{"title":"Updated At","description":"When the record was updated","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"}},"type":"object"},"Payroll":{"title":"Payroll model","description":"Payroll model","required":[],"properties":{"id":{"title":"Payroll ID","description":"ID of payroll","format":"int64","example":"12333221"},"company_id":{"title":"Company ID","description":"ID of company, defaults to user's company ID","format":"int64","example":"234"},"employee_id":{"title":"Employee ID","description":"ID of employee linked to this document","format":"int64","example":"234"},"start_date":{"title":"Start Date","description":"Start date of when the hours and wages were recorded from","format":"date","example":"2017-02-02"},"end_date":{"title":"End Date","description":"End date of when the hours and wages were recorded from","format":"date","example":"2017-02-02"},"total_hours":{"title":"Total Hours","description":"The total hours worked by the employee","format":"int32","example":"234"},"total_wages":{"title":"Total Wages","description":"The total wages earned by the employee","format":"float","example":"2312.01"},"term_date":{"title":"Employee Termination Date","description":"When the employee was terminated","format":"date","example":"2017-02-02"},"created_at":{"title":"Created At","description":"When the record was added","format":"datetime","example":"2017-02-02 18:31:45"},"updated_at":{"title":"Updated At","description":"When the record was updated","format":"datetime","example":"2017-02-02 18:31:45"}},"type":"object"},"PayrollBulk":{"title":"Payroll Bulk Model","description":"Payroll Bulk Submission","required":["employee_id","ssn","total_hours","total_wages"],"properties":{"company_id":{"title":"Company ID","description":"ID of company, defaults to user's company ID, or existing employee's company","format":"int64","example":234},"employee_id":{"title":"Employee ID","description":"ID of employee, this is not required if SSN is provided","format":"int64","example":234},"ssn":{"title":"Employee SSN","description":"4 or 9 digit SSN of employee, this is not required if employee_id is provided","format":"int64","example":"112234221"},"start_date":{"title":"Start Date","description":"Start date of when the hours and wages were recorded from, if not provided the start_date will be pulled from the employee start date","format":"date","example":"2017-02-02"},"end_date":{"title":"End Date","description":"End date of when the hours and wages were recorded from, if not provided the end date will be one year after the start date","format":"date","example":"2017-02-02"},"total_hours":{"title":"Total Hours","description":"The total hours worked by the employee","format":"int32","example":234},"total_wages":{"title":"Total Wages","description":"The total wages earned by the employee","format":"float","example":2312.010000000000218278728425502777099609375},"term_date":{"title":"Employee Termination Date","description":"When the employee was terminated","format":"date","example":"2017-02-02"},"override":{"title":"Override existing hours and wages","description":"If override is true, the previous data will be overriden if present, if not a new record is created","type":"boolean","example":true},"append":{"title":"Add to existing hours and wages","description":"If append is true, the previous data will be added to if present, if not a new record is created","type":"boolean","example":true}},"type":"object"},"PayrollBulkResultSet":{"title":"Payroll Bulk Result Model","description":"Payroll Bulk Submission Result","properties":{"successful":{"title":"Successful","description":"List of hours and wages imported","type":"array","items":{"$ref":"#\/components\/schemas\/PayrollBulkResult"}},"failed":{"title":"Failed","description":"List of hours and wages not imported with specific error messages as to why.","type":"array","items":{"$ref":"#\/components\/schemas\/PayrollBulkResult"}}},"type":"object"},"PayrollBulkResult":{"title":"Payroll Bulk Result Model","description":"Payroll Bulk Submission Result","properties":{"company_id":{"title":"Company ID","description":"ID of company, defaults to user's company ID, or existing employee's company","format":"int64","example":234},"employee_id":{"title":"Employee ID","description":"ID of employee, this is not required if SSN is provided","format":"int64","example":234},"ssn":{"title":"Employee SSN","description":"4 or 9 digit SSN of employee, this is not required if employee_id is provided","format":"int64","example":"112234221"},"start_date":{"title":"Start Date","description":"Start date of when the hours and wages were recorded from, if not provided the start_date will be pulled from the employee start date","format":"date","example":"2017-02-02"},"end_date":{"title":"End Date","description":"End date of when the hours and wages were recorded from, if not provided the end date will be one year after the start date","format":"date","example":"2017-02-02"},"total_hours":{"title":"Total Hours","description":"The total hours worked by the employee","format":"int32","example":234},"total_wages":{"title":"Total Wages","description":"The total wages earned by the employee","format":"float","example":2312.010000000000218278728425502777099609375},"term_date":{"title":"Employee Termination Date","description":"When the employee was terminated","format":"date","example":"2017-02-02"},"override":{"title":"Override existing hours and wages","description":"If override is true, the previous data will be overriden if present, if not a new record is created","type":"boolean","example":true},"append":{"title":"Add to existing hours and wages","description":"If append is true, the previous data will be added to if present, if not a new record is created","type":"boolean","example":true},"imported":{"title":"Imported","description":"If the hours and wages for the employee record was imported successfully","type":"boolean","example":true},"error":{"title":"Error","description":"If the imported value is value, then you can review this field for the specific error message.","type":"boolean","example":true}},"type":"object"},"Register":{"title":"Register model","description":"Register model","required":["first_name","last_name","email","company_name","address","city","state","zipcode","website","phone","ein","for_profit","comments","wotc_url"],"properties":{"integration":{"title":"Integration","description":"The 3rd party integration used","type":"string","maxLength":255,"example":"ADP"},"first_name":{"title":"First Name","description":"First name","type":"string","maxLength":255,"example":"John"},"last_name":{"title":"Last Name","description":"Last name","type":"string","maxLength":255,"example":"Doe"},"email":{"title":"Email","description":"Email","type":"string","format":"email","maxLength":255},"phone":{"title":"Phone","description":"Phone number","type":"string","maxLength":191,"example":"(619) 553-2123"},"company_name":{"title":"Company Name","description":"Name of company or DBA","type":"string","maxLength":191,"example":"Demo Company 123"},"address":{"title":"Address","description":"The street address","type":"string","maxLength":100,"example":"123 Street"},"address2":{"title":"PO Box, Apt, Suite","description":"The PO Box, Apt, Suite of the street address","type":"string","maxLength":191,"example":"Suite 22"},"city":{"title":"City","description":"The city the company operates in","type":"string","maxLength":191,"example":"New York"},"state":{"title":"State","description":"The state the company operates in","type":"string","maxLength":191,"example":"New York"},"zipcode":{"title":"Zipcode","description":"The zipcode \/ postal code the company operates in","type":"string","maxLength":191,"example":"92000"},"website":{"title":"Website","description":"The website of the company","type":"string","maxLength":255,"example":"https:\/\/google.com"},"ein":{"title":"Employer Identification Number","description":"The employer identification number (ein) of the company","type":"string","maxLength":255,"example":"33-4333333"},"for_profit":{"title":"Is Your Company a For-Profit?","description":"The if the company for profit or a non profit","type":"boolean","example":"true"}},"type":"object"},"User":{"title":"User model","description":"User model","properties":{"id":{"title":"ID","description":"ID of user","example":"1"},"company_id":{"title":"Company ID","description":"Company ID of user","type":"integer","example":"10"},"name":{"title":"Name","description":"Full name of user","type":"string","maxLength":255,"example":"John Doe"},"email":{"title":"Email","description":"Email","type":"string","format":"email","maxLength":255},"phone":{"title":"Phone","description":"Phone number","type":"string","maxLength":60,"example":"(619) 553-2123"},"created_at":{"title":"Created At","description":"When the record was added","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"},"updated_at":{"title":"Updated At","description":"When the record was updated","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"}},"type":"object"},"SftpCreate":{"title":"Sftp Create","description":"The model for creating sftp Accounts","required":["host","port","username","password","path"],"properties":{"company_id":{"title":"Company ID","description":"If you have a partner account or admin, then you supply which company to link this too, if its different than the one the authorized user is linked to.","type":"integer"},"name":{"title":"Name","description":"The name of SFTP account","type":"string","maxLength":255,"example":"8850s Directory"},"host":{"title":"Host","description":"The domain or IP address to connect to.","type":"string","maxLength":255,"example":"example.com"},"port":{"title":"Port","description":"the SFTP port to connect to, normally is port 22.","type":"integer","example":"22"},"username":{"title":"Username","description":"The username to log into the server","type":"string","maxLength":255,"example":"user_322"},"password":{"title":"Password","description":"The password to log into the server","type":"string","maxLength":255,"example":"password123"},"active":{"title":"Active","description":"If the sftp is active or not","type":"boolean","example":"true"},"interval":{"title":"Interval","description":"How often to connect to the server to pull documents","type":"integer","example":"5"}},"type":"object"},"SftpUpdate":{"title":"Sftp Update","description":"The model for updating sftp accounts","properties":{"name":{"title":"Name","description":"The name of SFTP account","type":"string","maxLength":255,"example":"8850s Directory"},"host":{"title":"Host","description":"The domain or IP address to connect to.","type":"string","maxLength":255,"example":"example.com"},"port":{"title":"Port","description":"the SFTP port to connect to, normally is port 22.","type":"integer","example":"22"},"username":{"title":"Username","description":"The username to log into the server","type":"string","maxLength":255,"example":"user_322"},"password":{"title":"Password","description":"The password to log into the server","type":"string","maxLength":255,"example":"password123"},"active":{"title":"Active","description":"If the sftp is active or not","type":"boolean","example":"true"},"interval":{"title":"Interval","description":"How often to connect to the server to pull documents","type":"integer","example":"5"}},"type":"object"},"Sftp":{"title":"Sftp","description":"Sftp account model","properties":{"id":{"title":"ID","description":"ID of sftp account","example":"1"},"company_id":{"title":"Company ID","description":"Company ID of user","type":"integer","example":"10"},"user_id":{"title":"User ID","description":"ID of user","type":"integer","example":"10"},"name":{"title":"Name","description":"The name of SFTP account","type":"string","maxLength":255,"example":"8850s Directory"},"host":{"title":"Host","description":"The domain or IP address to connect to.","type":"string","maxLength":255,"example":"example.com"},"username":{"title":"Username","description":"The username to log into the server","type":"string","maxLength":255,"example":"user_322"},"password_decrtpyed":{"title":"Password","description":"The password to log into the server","type":"string","maxLength":255,"example":"password123"},"port":{"title":"Port","description":"the SFTP port to connect to, normally is port 22.","type":"integer","example":"22"},"active":{"title":"Active","description":"If the sftp is active or not","type":"boolean","example":"true"},"interval":{"title":"Interval","description":"How often to connect to the server to pull documents","type":"integer","example":"5"},"created_at":{"title":"Created At","description":"When the record was added","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"},"updated_at":{"title":"Updated At","description":"When the record was updated","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"}},"type":"object"},"WotcCalculator":{"title":"WOTC Calculator Form model","description":"WOTC Calculator Form model","properties":{"address":{"title":"Full address of where they live","description":"What is your address?","type":"string","example":"123 Street San Diego CA 92121"},"is_under_40":{"title":"Under 40","description":"Are you under age 40?","type":"boolean","example":true},"has_snap":{"title":"SNAP Benefits","description":"Do you, or your family, receive SNAP Benefits? (Food Stamps or Cash Assistance)","type":"boolean","example":true},"has_ssi":{"title":"SSI Benefits","description":"Do you receive SSI Benefits?","type":"boolean","example":true},"is_veteran":{"title":"US Veteran","description":"Are you a US Veteran?","type":"boolean","example":true},"is_felon":{"title":"Felon","description":"Are you an ex-felon?","type":"boolean","example":true},"is_unemployed":{"title":"Unemployed","description":"Have you been unemployed for 6 months?","type":"boolean","example":true}},"type":"object"},"WebhookCreate":{"title":"Webhook Create","description":"The model for creating webhooks","required":["payload_url","content_type","events"],"properties":{"company_id":{"title":"Company ID","description":"If you have a partner account or admin, then you supply which company to link this too, if its different than the one the authorized user is linked to.","type":"integer"},"payload_url":{"title":"Payload Url","description":"The end-point to send the payload","type":"string","maxLength":255,"example":"http:\/\/example.com\/integration"},"content_type":{"title":"Content Type","description":"The accepted method to send POST data.","type":"enum","enum":["json","form"],"example":"json"},"secret":{"title":"Secret","description":"The key used for hmac-sha1 hashing to send with the request.","type":"string","maxLength":255,"example":"h28C3r@4J%qC"},"active":{"title":"Active","description":"If the webhook is active or not","type":"boolean","example":true},"events":{"title":"Events","description":"Which events to listen too","type":"array","items":{"type":"enum","enum":["wotc-status"],"example":"wotc-status"}}},"type":"object"},"WebhookUpdate":{"title":"Webhook Create","description":"The model for creating webhooks","properties":{"payload_url":{"title":"Payload Url","description":"The end-point to send the payload","type":"string","maxLength":255,"example":"http:\/\/example.com\/integration"},"content_type":{"title":"Content Type","description":"The accepted method to send POST data.","type":"enum","enum":["json","form"],"example":"json"},"secret":{"title":"Secret","description":"The key used for hmac-sha1 hashing to send with the request.","type":"string","maxLength":255,"example":"pPEyD383P#@K"},"active":{"title":"Active","description":"If the webhook is active or not","type":"boolean","example":true}},"type":"object"},"Webhook":{"title":"Webhook","description":"Webhook model","required":["payload_url","content_type"],"properties":{"id":{"title":"ID","description":"ID of webhook","example":"1"},"company_id":{"title":"Company ID","description":"Company ID of user","type":"integer","example":"10"},"user_id":{"title":"User ID","description":"ID of user","type":"integer","example":"10"},"payload_url":{"title":"Payload Url","description":"The end-point to send the payload","type":"string","maxLength":255,"example":"http:\/\/example.com\/integration"},"content_type":{"title":"Content Type","description":"The accepted method to send POST data.","type":"enum","enum":["json","form"],"example":"json"},"secret":{"title":"Secret","description":"The key used for hmac-sha1 hashing to send with the request.","type":"string","maxLength":255,"example":"66x7XB&S6XDe"},"active":{"title":"Active","description":"If the webhook is active or not","type":"boolean","example":"true"},"created_at":{"title":"Created At","description":"When the record was added","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"},"updated_at":{"title":"Updated At","description":"When the record was updated","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"}},"type":"object"},"Wotc":{"title":"WOTC model","description":"WOTC model","required":["first_name","last_name","dob","applied_on","contact_method","phone","ssn","address_street","address_city","address_state","address_zipcode","has_startdate","starting_wage","position","rehire","signature_date","signature_data","signature_image"],"properties":{"id":{"title":"WOTC ID","description":"The ID of the wotc submission","type":"int","maxLength":16,"example":"334232"},"first_name":{"title":"First Name","description":"First or given name","type":"string","maxLength":100,"example":"John"},"last_name":{"title":"Last Name","description":"Last or family name","type":"string","maxLength":100,"example":"Doe"},"middle_name":{"title":"Middle Name","description":"Middle name","type":"string","maxLength":100,"example":"Jack"},"other_last_names":{"title":"Other Last Name","description":"Other compound last names","type":"string","maxLength":100,"example":"Jack"},"contact_method":{"title":"Contact Method","description":"How the applicant should contacted, this alters if the phone number is required","type":"enum","enum":["email","phone","email_and_phone"],"example":"phone"},"phone":{"title":"Phone Number","description":"The primary phone number of contact","type":"string","maxLength":24,"example":"760-231-1223"},"ssn":{"title":"Social Security Number","description":"The nine digit SSN","type":"string","maxLength":16,"example":"123-45-3212"},"dob":{"title":"Date Of Birth","description":"When the person was born","type":"date","maxLength":16,"example":"1980-01-01"},"address_street":{"title":"Street Address","description":"Street Address","type":"string","maxLength":100,"example":"123 Street"},"address_street2":{"title":"Street Address 2","description":"Apt #, PO Box, etc","type":"string","maxLength":100,"example":"Apt 16"},"address_city":{"title":"City","description":"City","type":"string","maxLength":100,"example":"San Diego"},"address_state":{"title":"State","description":"State","type":"string","maxLength":30,"example":"CA"},"address_county":{"title":"County","description":"County","type":"string","maxLength":100,"example":"San Diego"},"address_zipcode":{"title":"Zipcode","description":"Zipcode \/ Postal Code","type":"string","maxLength":24,"example":"92121"},"applied_on":{"title":"Applicant Application Date","description":"When the applicant submitted their application","type":"date","maxLength":16,"example":"2022-01-01"},"has_startdate":{"title":"Has Start Date","description":"If the applicant is has been hired? If so this should be marked as true","type":"boolean","example":"true"},"started_on":{"title":"Applicant Start Date","description":"When the applicant starts their first day of work","type":"date","maxLength":16,"example":"2022-01-01"},"starting_wage":{"title":"Start Wage","description":"The amount of money that will make","type":"number","format":"double","maxLength":24,"example":"12.22"},"position":{"title":"Empolyment Position","description":"The job title or position they will hold at the company","type":"string","maxLength":100,"example":"12.22"},"rehire":{"title":"Rehire","description":"If the applicant is being rehired for the company","type":"boolean","example":"true"},"rehire_last_employment":{"title":"Last Date Of Employeement","description":"If the applicant is a rehire, what was their last date of employment","type":"date","maxLength":16,"example":"2022-01-01"},"unemployment_comp":{"title":"Unemployeement","description":"Have you been unemployed for at least 27 consecutive weeks, and collected any Unemployment Compensation during that time?","type":"boolean","example":"true"},"unemployment_comp_start":{"title":"Unemployeement benefits start date","description":"Enter start date of unemployment benefits. If unemployment_comp is marked as true, this value is required","type":"date","maxLength":16,"example":"2022-01-01"},"unemployment_comp_state":{"title":"Unemployeement benefits state","description":"City \/ State where benefits received. This is required if unemployment_comp is true.","type":"string","maxLength":100,"example":"CA"},"snap_benefits":{"title":"SNAP \/ Food Stamps","description":"Are you a member of a family that received SNAP Benefits (Supplemental Nutrition Assistance Program), or Food Stamps","type":"boolean","example":"true"},"snap_benefits_before":{"title":"SNAP \/ Food Stamps Before Or During","description":"For the 6 months before you were hired or, for at least 3 of the past 5 months, but you are no longer receiving them? This is required if snap_benefits is true.","type":"enum","enum":["3","6"],"example":"3"},"snap_benefits_extras_name":{"title":"SNAP \/ Food Stamps Primary Recipient","description":"Primary Recipient Name. This is required if snap_benefits is true.","type":"string","maxLength":255,"example":"John Doe"},"snap_benefits_extras_city_state":{"title":"SNAP \/ Food Stamps City \/ State","description":"City \/ State where benefits received. This is required if snap_benefits is true.","type":"string","maxLength":100,"example":"New York"},"tanf_benefits":{"title":"TANF or Cash Benifits","description":"Are you a member of a family that received TANF (Temporary Assistance for Needy Families), or Cash Benefits","type":"boolean","example":"true"},"tanf_benefits_before":{"title":"TANF Before","description":"For any 9 months during the past 18 months before you were hired? Or, for any 18 Months beginning after August 5, 1997 and ending within the past 2 years? Or, did your family stop being eligible within the last 2 years because the law limited the maximum time those payments can be made? This is required if TANF is true","type":"enum","enum":["9","18","2"],"example":"18"},"tanf_benefits_extras_name":{"title":"TANF Primary Recipient","description":"Primary Recipient Name. This is required if tanf_benefits is true","type":"string","maxLength":255,"example":"John Doe"},"tanf_benefits_extras_city_state":{"title":"TANF City \/ State","description":"City \/ State where benefits received. This is required if tanf_benefits is true","type":"string","maxLength":100,"example":"New York"},"veteran":{"title":"Veteran of the US Armed Forces","description":"Are you a Veteran of the US Armed Forces?","type":"boolean","example":"true"},"veteran_compensation":{"title":"Veteran Disability Compensation","description":"Are you a veteran entitled to compensation for a service-connected disability?","type":"boolean","example":"true"},"veteran_compensation_discharged":{"title":"Veteran Discharged","description":"Were you discharged or released from active duty within a year before you were hired?","type":"boolean","example":"true"},"veteran_compensation_unemployed":{"title":"Veteran Unemployed Compensation","description":"Where you unemployed for a combined period of at least 6 months (whether or not consecutive) during the year before you were hired?","type":"boolean","example":"true"},"veteran_snap":{"title":"Veteran SNAP","description":"Are you a member of a family that received Supplemental Nutrtion Assistance Program (SNAP) benefits (Food Stamps) for at least 3 months during the 15 months before you were hired?","type":"boolean","example":"true"},"veteran_snap_name":{"title":"Veteran SNAP Primary Recipient","description":"Primary Recipient Name. This is required if veteran_snap is true","type":"string","maxLength":255,"example":"John Doe"},"veteran_snap_city_state":{"title":"Veteran SNAP City \/ State","description":"City \/ State where benefits received. This is required if veteran_snap is true","type":"string","maxLength":100,"example":"New York"},"veteran_unemployed_6_or_greater":{"title":"Veteran Unemployment","description":"Are you a Veteran that was unemployed for at least 6 months, before you were hired?","type":"boolean","example":"true"},"veteran_unemployed_6_less_than":{"title":"Veteran Unemployment","description":"Are you a Veteran that was unemployed for less than 6 months before you were hired?","type":"boolean","example":"true"},"convicted_before_hired":{"title":"Convicted of a Felony","description":"Were you Convicted of a Felony, or released from prison during the year before you were hired?","type":"boolean","example":"true"},"convicted_date":{"title":"Date Of Conviction","description":"Enter date of conviction. If convicted_before_hired is marked as true, this value is required","type":"date","maxLength":16,"example":"2022-01-01"},"convicted_release":{"title":"Release Date Of Conviction","description":"Enter date of release. If convicted_before_hired is marked as true, this value is required","type":"date","maxLength":16,"example":"2022-01-01"},"convicted_type":{"title":"Convicted Type","description":"Was this a Federal State conviction or State conviction? This is required if convicted_before_hired is true","type":"enum","enum":["federal","state"],"example":"federal"},"rural_or_empowerment_zone":{"title":"Live in Rural Renewal or Empowerment Zone?","description":"Do you live in a Rural Renewal Community or an Empowerment Zone?","type":"boolean","example":"true"},"rehab_agency":{"title":"Vocational Rehab Agency","description":"Were you referred to an employer by a Vocational Rehab Agency approved by the State?","type":"boolean","example":"true"},"employment_network":{"title":"Employement Network","description":"Were you referred by an Employment Network, under the Ticket to Work Program?","type":"boolean","example":"true"},"veteran_affairs":{"title":"Veteran Affairs Referral","description":"Were you referred by the Dept. of Veteran Affairs?","type":"boolean","example":"true"},"ssi_benefit":{"title":"SSI Benefit","description":"Did you receive SSI Benefit (Supplemental Security Income) for any month ending within 60 Days before you were hired?","type":"boolean","example":"true"},"conditional_certification":{"title":"SWA Conditional Certification ","description":"Have you received a conditional certification from a State Workforce Agency (SWA), or a participating local agency for the Work Opportunity Credit?","type":"boolean","example":"true"},"signature_date":{"title":"Signature Date","description":"The date of when the document was signed","type":"date","maxLength":16,"example":"2019-06-20"},"signature_image":{"title":"Signature Image","description":"The base64 PNG image","type":"string","example":"data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="},"signature_data":{"title":"Signature Data","description":"The JSON array of the raw signature. This is a json array of each stroke with the position, timestamp and color. Timestamps are in milliseconds since 00:00:00 UTC on 1 January 1970. While this is required","type":"string","example":"[[{'x':363,'y':81,'time':1548147908660,'color':'black'}]]"},"created_at":{"title":"Created At","description":"When the applicant was added","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"},"updated_at":{"title":"Updated At","description":"When the applicant was updated","type":"datetime","format":"datetime","example":"2017-02-02 18:31:45"}},"type":"object"}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","in":"header"},"JWT":{"type":"apiKey","name":"Authorization","in":"header"},"passport":{"type":"oauth2","description":"Laravel passport oauth2 security.","in":"header","scheme":"https","flows":{"password":{"authorizationUrl":"https:\/\/wotc.com\/portal\/portal\/oauth\/authorize","tokenUrl":"https:\/\/wotc.com\/portal\/portal\/oauth\/token","refreshUrl":"https:\/\/wotc.com\/portal\/portal\/token\/refresh","scopes":[]}}}}},"tags":[{"name":"employee","description":"Operations about the company employees"},{"name":"applicant","description":"An applicant is very similar to an employee, however applicants have no start dates"}],"externalDocs":{"description":"Find out more about WOTC","url":"https:\/\/tcservicesusa.com\/"}}