![\"API](\"https://rest.fadv.com/docs/images/api-steps.png\")
First Advantage API is our latest enterprise ready API suite to access all of First Advantage Products and Services.
This Developer Portal includes a API Reference, Sample Code and Sandbox.
\nGetting started with First Advantage APIs is simple 3 step process.
\n
Order is immediately created when Client has and sends all Candidate information needed for FADV Screening
\n![\"API](\"https://rest.fadv.com/docs/images/new-screening-request.png\")
![\"API](\"https://rest.fadv.com/docs/images/webhook-status.png\")
Order after client sends Candidate Information and Candidate is Invited to Review and Provide Missing Information required for FADV Screening
\n![\"API](\"https://rest.fadv.com/docs/images/candidate-invite.png\")
Candidate gets email from FADV - they then complete the Candidate Profile by providing consents and missing Information.\nCandidate Profiles can be from FADV Direct Advantage or Profile Advantage Platforms.
\n
FADV pushes Order Status and Results to the Client’s Webhook
\n![\"API](\"https://rest.fadv.com/docs/images/check-order-status.png\")
FADV pushes Order Status and Results to the Client’s Webhook.
\n![\"API](\"https://rest.fadv.com/docs/images/report-link.png\")
Note: \nThe Report Link is a one-time use URL that takes the User directly to the Detailed Report in FADV. \nThe URL expires after a few minutes and has to generated for each use.
\nTry create order now
\nHeaders
\n Authorization: \n \nAttributes (Order)
\nBody
\n {\n \"candidate_id\": \"3898cf00-34ab-11e7-b679-0242ac110004\",\n \"package_id\" : \"3173\",\n \"employment_start_date\": \"2025-05-16\",\n \"notification_url\" : \"webhook URL for status notifications\",\n \"client_references\" :[\"SFApplicantId_97\", \"SFRequsitionId_162\"],\n \"user_defined_fields\": [\"FIN-DIR\", \"Alliances (ALNCE)\", \"GCS Asia, Pacific & Japan (GCS_APJ)\", \"San Francisco, USA (US_SF)\", \"\", \"USD\"],\n \"locale\":{\n \"language_code\":\"\",\n \"country_code\":\"\"\n },\n \"quote_backs\":[{\n \"name\": \"guid\",\n \"value\": \"\"\n },\n {\n \"name\": \"location\",\n \"value\": \"\"\n }\n ],\n \"add_ons\":\n [\n {\"type\" :\"ED\"},\n {\"type\" :\"FEMP\"},\n {\"type\" :\"PEMP\"},\n {\"type\" :\"MVR\"}\n ]\n }\nHeaders
\n location:location ->WPS-6842096\nAttributes (string)
\nBody
\n {\n \"order_id\": \"WPS-684XX96\"\n }\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\nOrder data object
\ncandidate_id (string, required) - Candidate Id for creating orderpackage_id (string) - Package Id to create orderemployment_start_date (string, optional) - The employment start date for the applicant.account_id (string, optional) - Account Id to create ordertwo_step: false (boolean, optional) - flag to create 1-step or 2-step ordernotification_url (string, optional) - Webhook URL for status notificationsclient_references (array[string], optional) user_defined_fields (array[string], optional) quote_backs (array[quotebackasType], optional) additional_attributes (additionalattributesasType, optional) - Requestor Detaillocale (locale, optional) - Locale informationposition_applied_for (string, optional) - name of the position to applyposition_locations (array[positionlocationasType], optional) add_ons (array[addonsasType], optional)quoteback reference for clients.
\nname (string, optional) - quoteback namevalue (string, optional) - quoteback valueRequestor Detail
\norder_as (orderas, optional) - Ordering Account detailssystem: EA (string, optional) - System where order is to be createdaccount_id (string) - Requested account Iduser_id (string) - Requested user Idemail (string) - Requested email Idlanguage_code (string, optional) - Language codecountry_code (string, optional) - Country codeDetails of the position
\ncity (string, optional) - Position in the citystate (string, optional) - Position in the statecountry (string, optional) - Position in the countryadd-on indicator for screening components
\ntype (string, optional) - type code for screening componentHeaders
\n Authorization: \n \nAttributes (Adjudicate)
\nBody
\n {\n \"score\": \"Eligible\",\n \"score_status\" : \"\",\n \"additional_attributes\": \n {\n \"order_as\": \n { \n \"account_id\": \"100100ABC\",\n \"user_id\": \"John\",\n \"email\": \"john.doe@fadv.com\"\n }\n } \n }\nAttributes (string)
\nBody
\n {\n \"status\": \"Success\"\n }\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\nAdjudicate data object
\nscore (string, required) - scorescore_status (string, optional) - score statusadditional_attributes (additionalattributesasType, optional) - Requestor DetailRequestor Detail
\norder_as (orderas, optional) - Ordering Account detailssystem: EA (string, optional) - System where order is to be createdaccount_id (string) - Requested account Iduser_id (string) - Requested user Idemail (string) - Requested email IdHeaders
\n Authorization: \nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\nOrder status response.
\norder (statusorderidresponse, required) - Order Status.Order status response.
\norder_id (string, required) - First Advantage assigned ID (Case ID) for the applicant's background search order for successful requests.order_status (string, optional) - Case level status. Values are Completed, Preliminary, InProgress, Hold, Cancelled, Disabled, UnderConstruction, Pending and UnexpectedStatus.result_status (string, optional) - Overall results for a completed case. Background Investigation Values[Pass, Fail, Review and UnexpectedResult]. Drug Test Values[ Positive, Unverified, PassWithRestrictions, Scheduled, Rescheduled, NoShow, Collected, PartiallyComplete, NegativeDilute, Negative, UnexpectedResult, HoldMRO, Cancel, RuleViolation].score (string, optional) - Score value for scored cases only. This is sent only at Case Level. Values[ Eligible, Ineligible, RetainInPlace, Cancelled, Decisional, UnexpectedScore, Supplemented].url (string, optional) - Link to the Enterprise Advantage website to view the order status and results. This link will require login authentication.screenings (array[screening], optional) - Contains the details of each screening for this casemeta_data (metadatatype, optional)order_status (string, optional) - This is element level status. Screening status.sub_type (string, optional) - Component subtype value.description (string, optional) - Description of screening type.result_status (string, optional) - Screening result for completed screenings.type (string, optional) - Component type value.Meta data submitted with order
\nclient_references (array[string], optional) user_defined_fields (array[string], optional) quote_backs (array[quotebacktype], optional)name (string, required) value (string, required)id (string, required)
\naccount (string, required)
\nProxy to Order get status api service
\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\n","urlObject":{"protocol":"https","path":["api","v1.1","orders","","status","viewAccount",""],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"76e5419c-4036-4171-bbf5-bed0ac8f4abe","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/viewAccount/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"73bd91c1-5a3b-49d2-9933-cc85687d938a","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/viewAccount/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ff2359fe-9e67-4989-afb1-b54eb3fb15c1","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/viewAccount/"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"8d1d61fc-dd9d-46b9-9067-c66da87748ac","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/viewAccount/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c27dbbfb-89a3-48b2-bc97-a16b11b9f277"},{"name":"OrdersStatusViewAccountViewUserUserById","id":"e5a3e34a-8f51-4758-a811-5cb97602646b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/viewAccount//viewUser/","description":"id (string, required)
\naccount (string, required)
\nuser (string, required)
\nProxy to Order get staus api service
\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\n","urlObject":{"protocol":"https","path":["api","v1.1","orders","","status","viewAccount","","viewUser",""],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"9ec5139f-dc08-4d36-995a-d113712fab7f","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/viewAccount//viewUser/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f97ce26c-6bf7-4ef2-b318-78aa75d86515","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/viewAccount//viewUser/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"397fd397-834c-4060-b7b4-fe473272b3af","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/viewAccount//viewUser/"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"bdd6b58c-1287-488e-a93b-63267c197193","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/viewAccount//viewUser/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e5a3e34a-8f51-4758-a811-5cb97602646b"},{"name":"OrdersStatusDetailsById","id":"2889849a-ed4c-4102-b882-1174f22301f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/details","description":"Try It !
\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\nOrder status response
\norder (statusdetailsorderidresponse, required) - Order detailed status.Order status response
\norder_id (string, required) - First Advantage assigned ID (Case ID) for the applicant's background search order for successful requests.screening_status (screeningstatus, required) - Case level status.screenings (array[screening], optional) - Contains the details of each screening for this casescreening_ results_url (string, optional) - Link to the Enterprise Advantage website to view the order status and results.meta_data (metadatatype, optional)order_status (string, optional) - Case level status.score (string, optional) - Score value for scored cases only. This is sent only at Case Level.result_status (string, optional) - Overall results for a completed case.order_status (string, optional) - This is element level status. Screening status.sub_type (string, optional) - Component subtype value.description (string, optional) - Description of screening type.result_status (string, optional) - Screening result for completed screenings.type (string, optional) - Component type value.Meta data submitted with order
\nclient_references (array[string], optional) user_defined_fields (array[string], optional) quote_backs (array[quotebacktype], optional)name (string, required) value (string, required)id (string, required)
\naccount (string, required)
\nProxy to Order get status details api service
\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\n","urlObject":{"protocol":"https","path":["api","v1.1","orders","","status","details","viewAccount",""],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"421e94dd-2389-43b3-8adb-fa9ff3223bec","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/details/viewAccount/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"014333db-1422-4018-b076-a84185ad93f5","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/details/viewAccount/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"16584a0f-7c0f-42a1-b42a-e83c790c7f69","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/details/viewAccount/"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"02d9a3f1-16de-4139-bba2-d0d6fedcc1ab","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/details/viewAccount/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"630745e8-cc9a-490d-a661-ae8ece10c07e"},{"name":"OrdersStatusDetailsViewAccountViewUserUser","id":"b5f560f7-c981-46f4-82ff-2bd726ff31bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/details/viewAccount//viewUser/","description":"id (string, required)
\naccount (string, required)
\nuser (string, required)
\nProxy to Order get status details api service
\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\n","urlObject":{"protocol":"https","path":["api","v1.1","orders","","status","details","viewAccount","","viewUser",""],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"add08cdd-846b-41bb-8379-636f29211268","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/details/viewAccount//viewUser/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e140f16d-8db5-41b6-bfb0-2f4d2d617f1b","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/details/viewAccount//viewUser/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ca362862-40ac-4ac5-a287-b061603cf97d","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/details/viewAccount//viewUser/"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4a34b18e-c305-4138-bf45-e051f3fb4224","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/details/viewAccount//viewUser/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b5f560f7-c981-46f4-82ff-2bd726ff31bf"},{"name":"OrdersReportById","id":"ad382b4e-bfd4-4f3f-b509-4c17e701ed32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/orders//report","description":"Proxy to Order get link api service
\nHeaders
\n Authorization: \nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\n","urlObject":{"protocol":"https","path":["api","v1.1","orders","","report"],"host":["rest.fadv.com"],"query":[{"disabled":true,"description":{"content":"enum, optional
\n","type":"text/plain"},"key":"format","value":""}],"variable":[]}},"response":[{"id":"0ecf485c-5445-4ce3-8907-212da7ce6a8c","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":{"raw":"https://rest.fadv.com/api/v1.1/orders//report","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","orders","","report"],"query":[{"key":"format","value":"","description":"enum, optional","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b03ee12c-b10a-4c3d-911a-965301fd0fa5","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":{"raw":"https://rest.fadv.com/api/v1.1/orders//report","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","orders","","report"],"query":[{"key":"format","value":"","description":"enum, optional","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f9e0dfa2-643d-4e12-9f96-4806a4cf5fdd","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":{"raw":"https://rest.fadv.com/api/v1.1/orders//report","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","orders","","report"],"query":[{"key":"format","value":"","description":"enum, optional","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"d7512837-39e6-4bfb-b280-233507135a2f","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":{"raw":"https://rest.fadv.com/api/v1.1/orders//report","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","orders","","report"],"query":[{"key":"format","value":"","description":"enum, optional","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ad382b4e-bfd4-4f3f-b509-4c17e701ed32"},{"name":"OrdersReportViewAccountByIdAndAccount","id":"9893b3e8-10f6-4134-889a-df9647ac54bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//report/viewAccount/","description":"id (string, required)
\naccount (string, required)
\nProxy to Order get link api service
\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\n","urlObject":{"protocol":"https","path":["api","v1.1","orders","","report","viewAccount",""],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"f183ad55-1be1-4578-8a9e-fa4115939386","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//report/viewAccount/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"1cebb1b8-1b03-4ae6-8a28-d499dbd867c8","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//report/viewAccount/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"5b87fd6c-fd85-4f71-a492-fec26c3f3d61","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//report/viewAccount/"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4488925f-ac3a-4247-bef7-e6ea14518dfc","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//report/viewAccount/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9893b3e8-10f6-4134-889a-df9647ac54bc"},{"name":"OrdersReportViewAccountViewUserUserById","id":"cd04ee63-2761-4309-bbb5-6753af2b9443","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//report/viewAccount//viewUser/","description":"id (string, required)
\naccount (string, required)
\nuser (string, required)
\nProxy to Order get link api service
\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\n","urlObject":{"protocol":"https","path":["api","v1.1","orders","","report","viewAccount","","viewUser",""],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"4997fa11-e3aa-472c-8d1f-39792a121f25","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//report/viewAccount//viewUser/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f5dd6f5f-aa3d-4a00-8e6b-ccb1177e63d5","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//report/viewAccount//viewUser/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"fbb475c5-b6e3-48ab-9133-ce404b819cfe","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//report/viewAccount//viewUser/"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"539159de-6e0f-40c6-b44b-0ebad6cf7fb6","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//report/viewAccount//viewUser/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"cd04ee63-2761-4309-bbb5-6753af2b9443"},{"name":"OrdersStatusComponentsById","id":"8d630fe0-31ba-4dde-adae-36758787d0f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/components","description":"Try It !
\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\nOrder status response
\norder (statusdetailsorderidresponse, required) - Order detailed status.Order status response
\norder_id (string, required) - First Advantage assigned ID (Case ID) for the applicant's background search order for successful requests.screening_status (screeningstatus, required) - Case level status.screenings (array[screening], optional) - Contains the details of each screening for this casescreening_ results_url (string, optional) - Link to the Enterprise Advantage website to view the order status and results.meta_data (metadatatype, optional)order_status (string, optional) - Case level status.score (string, optional) - Score value for scored cases only. This is sent only at Case Level.result_status (string, optional) - Overall results for a completed case.order_status (string, optional) - This is element level status. Screening status.sub_type (string, optional) - Component subtype value.description (string, optional) - Description of screening type.result_status (string, optional) - Screening result for completed screenings.type (string, optional) - Component type value.Meta data submitted with order
\nclient_references (array[string], optional) user_defined_fields (array[string], optional) quote_backs (array[quotebacktype], optional)name (string, required) value (string, required)id (string, required)
\naccount (string, required)
\nProxy to Order get status components api service
\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\n","urlObject":{"protocol":"https","path":["api","v1.1","orders","","status","components","viewAccount",""],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"5431e364-2262-4b19-9de8-25309bf97d4e","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/components/viewAccount/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"1f66a12b-ac2c-4762-aff7-11e95830fd21","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/components/viewAccount/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e31fea69-7f73-4f87-b8cf-7fa05596ad59","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/components/viewAccount/"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"2f906942-076e-4dc2-a0da-48dbd401eb00","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/components/viewAccount/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"afd83334-9055-4313-9001-098b6f0e5274"},{"name":"OrdersStatusComponentsViewAccountViewUserUser","id":"7f6dcfc4-6e33-46f7-a6fe-c2c1a26bbf7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/components/viewAccount//viewUser/","description":"id (string, required)
\naccount (string, required)
\nuser (string, required)
\nProxy to Order get status components api service
\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\n","urlObject":{"protocol":"https","path":["api","v1.1","orders","","status","components","viewAccount","","viewUser",""],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"6f109016-dfde-45ca-b472-21ed75092baa","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/components/viewAccount//viewUser/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6465f35e-8fd1-482c-a856-6e08b47e6726","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/components/viewAccount//viewUser/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e3fd85d7-67c9-4520-91d6-4b609f02ec2a","name":"404 Not Found","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/components/viewAccount//viewUser/"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"987de1e7-1f45-4c86-90b6-a019bcc73c12","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//status/components/viewAccount//viewUser/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7f6dcfc4-6e33-46f7-a6fe-c2c1a26bbf7c"},{"name":"Get documents by order id","id":"9d783513-ac20-4761-974a-1bbe34bcd418","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/orders//documents","description":"Fetch all the documents for a given order
\nAttributes (array[Orders Documents response])
\nBody
\n [\n {\n \"filename\": \"Barclays Fax Cover.doc\",\n \"elements\": [\n \"INTLED:1\",\n \"INTLCVC:1\",\n \"PRICPGS:1\",\n \"MVR:1\",\n \"PRINCRP:1\"\n ],\n \"name\": \"Curriculum Vitae/Resume\",\n \"description\": \"Curriculum Vitae/Resume\",\n \"id\": \"b7d69c27554ec3ae\",\n \"type\": \"text/plain\"\n }\n ]\nNo additional error description is provided.
\nNo additional error description is provided.
\n+ Attributes (ResponseError)\n\n\n+ Body\n\n {\n \"error\" : \"E-104 Error occurred while processing your request\"\n }\nfilename (string, required) elements (array[string], optional)name (string, required) description (string, required) id (string, required) type (string, required)code (string, optional) message (string, optional)##AccountDetailsResponse (object)
\ndetails (array[AccountDetailsType], required)Account details
\naccount_id (string, required) - Account idname (string, required) - Account nameList documents for a given order by order id and order account
\nid (string, required)
\naccount (string, required)
\nAttributes (array[Orders Documents ViewAccount response])
\nBody
\n [\n {\n \"filename\": \"Barclays Fax Cover.doc\",\n \"elements\": [\n \"INTLED:1\",\n \"INTLCVC:1\",\n \"PRICPGS:1\",\n \"MVR:1\",\n \"PRINCRP:1\"\n ],\n \"name\": \"Curriculum Vitae/Resume\",\n \"description\": \"Curriculum Vitae/Resume\",\n \"id\": \"b7d69c27554ec3ae\",\n \"type\": \"text/plain\"\n }\n ]\nNo additional error description is provided.
\nNo additional error description is provided.
\n+ Attributes (ResponseError)\n\n\n+ Body\n\n {\n \"error\" : \"E-104 Error occurred while processing your request\"\n }\nfilename (string, required) elements (array[string], optional)name (string, required) description (string, required) id (string, required) type (string, required)code (string, optional) message (string, optional)##AccountDetailsResponse (object)
\ndetails (array[AccountDetailsType], required)Account details
\naccount_id (string, required) - Account idname (string, required) - Account nameFetch document's data (binary data) by order id and document id
\nid (string, required)
\ndocument_id (string, required)
\nNo additional error description is provided.
\nNo additional error description is provided.
\n+ Attributes (ResponseError)\n\n\n+ Body\n\n {\n \"error\" : \"Given document is not valid.\"\n }\nNo additional error description is provided.
\n+ Attributes (ResponseError)\n\n\n+ Body\n\n {\n \"error\" : \"E-104 Error occurred while processing your request\"\n }\ncode (string, optional) message (string, optional)##AccountDetailsResponse (object)
\ndetails (array[AccountDetailsType], required)Account details
\naccount_id (string, required) - Account idname (string, required) - Account nameFetch document's data (binary data) by order id, document id and order account
\nid (string, required)
\ndocument_id (string, required)
\naccount (string, required)
\nNo additional error description is provided.
\nNo additional error description is provided.
\n+ Attributes (ResponseError)\n\n\n+ Body\n\n {\n \"error\" : \"Given document is not valid.\"\n }\nNo additional error description is provided.
\n+ Attributes (ResponseError)\n\n\n+ Body\n\n {\n \"error\" : \"E-104 Error occurred while processing your request\"\n }\ncode (string, optional) message (string, optional)##AccountDetailsResponse (object)
\ndetails (array[AccountDetailsType], required)Account details
\naccount_id (string, required) - Account idname (string, required) - Account nameHeaders
\n Authorization: \n \nAttributes (Cancel order)
\nBody
\n {\n \"additional_attributes\":{\n \"order_as\":{\n \"account_id\":\"280280COR\",\n \"user_id\":\"REST\",\n \"email\":\"test@invalidmail.com\"\n }\n },\n \"cancel_order_criteria\":{\n \"cancel_reasons\" :[\n \"Amend self-report\"\n ],\n \"client_references\":[\n \"CR1\",\n \"CR2\"\n ],\n \"identities\":{\n \"government_ids\":{\n \"hasSSN\":\"N\",\n \"ids\":[\n {\n \"type\":\"CUDRDP\",\n \"number\":\"501515111501515111\",\n \"country\":\"MX\"\n }\n ]\n }\n },\n \"package_id\":\"2112\",\n \"additional_items\":[\n {\n \"name\":\"cancellation_reason1\",\n \"value\":\"cancellation reason value1\"\n }\n ],\n \"creation_date_time\":\"2017-06-15T10:09:02.01\"\n }\n }\nAttributes (Orders Cancel response)
\nBody
\n {\n \"status\": \"Cancelled\"\n }\n \n or\n \n {\n \"status\": \"Cancelled\",\n \"cancel_reasons\": [\n \"Amend self-report\"\n ]\n }\nNote: The source response example is incomplete or invalid JSON and is shown as documented.
\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nAttributes (commonerror)
\nBody
\n {\n \"code\": \"{{custome error code}}\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Aug 13 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nInternal server error
\nCancel order object
\nadditional_attributes (additionalattributes, optional) - Ordering Account detailscancel_order_criteria (cancelordercriteria, optional) - Cancel order detailsRequestor Detail
\norder_as (orderas, optional) - Ordering Account detailsaccount_id (string) - Requested account Iduser_id (string) - Requested user Idemail (string) - Requested email IdCancel order details
\ncancel_reasons (array[string], optional) - Cancel reasons for order cancellationclient_references (array[string], optional) - Client references for order cancellationidentities (identities, optional) - identity data to be used for cancellationpackage_id (string, optional) - package id for the orderadditional_items (array[additionalitems], optional) - array of additional itemscreation_date_time (string, optional) - creation date time for the orderidentity data to be used for cancellation
\ngovernment_ids (governmentids, optional) - identity data to be used for cancellationidentity data to be used for cancellation
\nhasSSN (string, optional) - Y or N value for hasSSNhasUAN (string, optional) - Y or N value for hasUANids (array[ids], optional) - id detailsId details
\ntype (string, optional) - Id typenumber (string, optional) - Id numbercountry (string, optional) - countryadditional items data.
\nname (string, optional) - additional item namevalue (string, optional) - additional item valuestatus (string, required)cancel_reasons (array[string], optional) - Cancel reasons used for order cancellationcode (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)Ability to create and view First Advantage Screening Orders.
\nOrder Creation requires Candidate ID and Package ID.
\nActions Supported:
\nCreate a Candidate
\nHeaders
\n Authorization: \n \nAttributes (candidate)
\nBody
\n {\n \"persons\":[\n {\n \"given_name\":\"John\",\n \"middle_name\":\"M\",\n \"family_name\":\"Doe\",\n \"type\":\"subject\"\n },\n {\n \"given_name\":\"Tom\",\n \"middle_name\":\"X\",\n \"family_name\":\"Smith\",\n \"type\":\"alias\"\n }\n ],\n \"email\":\"c18d@mail.com\",\n \"dob\":\"1995-11-29\",\n \"gender\":\"male\",\n \"identities\":{\n \"licenses\":[\n {\n \"provider_ref_id\" : \"custom_value1\",\n \"license_name\":\"mvr\",\n \"type\":\"Non-Commercial\",\n \"number\":\"123-456-789\",\n \"state\":\"NY\",\n \"country\":\"US\",\n \"license_agency\" : \"Pune University\",\n \"candidate_name\" : \"Candidate name on license\",\n \"license_description\":\"description for the license\"\n },\n {\n \"license_name\":\"cer\",\n \"type\":\"Commercial\",\n \"number\":\"777-888-999\",\n \"state\":\"AZ\",\n \"country\":\"US\",\n \"license_agency\" : \"Pune University\",\n \"candidate_name\" : \"Candidate name on license\",\n \"license_description\":\"description for the license\"\n }\n ],\n \"government_ids\":{\n \"hasSSN\":\"Y\",\n \"hasUAN\" : \"Y\",\n \"ids\":[\n {\n \"type\":\"SSN\",\n \"number\":\"77-777-7777\",\n \"country\":\"US\",\n \"issue_date\":\"2016-01-01\",\n \"expiry_date\":\"2026-01-01\",\n \"description\":\"\"\n },\n {\n \"type\":\"PASSPORT\",\n \"number\":\"77-777-777-ABC\",\n \"country\":\"US\",\n \"issue_date\":\"2016-01-01\",\n \"expiry_date\":\"2026-01-01\",\n \"description\":\"\"\n },\n {\n \"type\":\"GOVT\",\n \"number\":\"NS15RR\",\n \"country\":\"CA\",\n \"id_type_code\":\"LASTAAD\",\n \"description\":\"Govt id\"\n },\n {\n \"type\":\"UAN\",\n \"number\":\"345721680\",\n \"country\":\"UK\",\n \"description\":\"UAN number\"\n }\n ]\n }\n },\n \"addresses\":[\n {\n \"street_address\":\"123 Abc street\",\n \"street_address2\":\"address line 2\",\n \"city\":\"Hudson\",\n \"state\":\"NY\",\n \"country\":\"US\",\n \"zip_code\":\"112233\",\n \"start_at\":\"2010-03-09\",\n \"is_permanent\" : \"Yes\"\n },\n {\n \"street_address\":\"456 Def street\",\n \"street_address2\":\"address line 2\",\n \"city\":\"Pheonix\",\n \"state\":\"AZ\",\n \"country\":\"US\",\n \"zip_code\":\"223344\",\n \"start_at\":\"2009-10-21\",\n \"end_at\":\"2010-03-09\"\n }\n ],\n \"employers\":[\n {\n \"provider_ref_id\" : \"custom_value2\",\n \"employer_name\":\"FADV\",\n \"employee_id\" : \"E000\",\n \"employer_address\":{\n \"country_code\":\"US\",\n \"postal_code\":\"10001\",\n \"region\":\"NY\",\n \"municipality\":[\n {\n \"type\":\"city\",\n \"value\":\"NY\"\n }\n ],\n \"delivery_address\":{\n \"address_line\":[\n \"9th Main,1st Cross\"\n ]\n }\n },\n \"title\":\"Developer\",\n \"dates_of_employment\":[\n {\n \"start_at\":\"2000-09-08\",\n \"end_at\":\"2014-11-11\"\n }\n ],\n \"compensation\":[\n {\n \"interval_type\":\"weekly\",\n \"currency\":\"USD\",\n \"value\":\"600\",\n \"when\":\"starting\"\n },\n {\n \"interval_type\":\"weekly\",\n \"currency\":\"USD\",\n \"value\":\"900\",\n \"when\":\"ending\"\n }\n ],\n \"reason_for_leaving\":\"No Reason for first Employment\",\n \"permission_to_contact\":\"true\",\n \"duties\":\"No Description for first Employment\",\n \"job_type\" : \"selfEmployer\",\n \"supervisor\": {\n \"supervisor_name\": \"Su\",\n \"supervisor_title\": \"Hiring Lead\",\n \"supervisor_contact_info\": {\n \"internet_email_address\": \"Su123@testmail.com\",\n \"contact_method\": {\n \"telephone\": [\n {\n \"number\": \"111-222-1234\",\n \"type\": \"primary\",\n \"extension\": \"69\"\n }\n ],\n \"postal_address\": {\n \"type\": \"current\",\n \"country_code\": \"IN\",\n \"region\": \"KA\", \n \"postal_code\": \"800014\",\n \"municipality\": [\n {\n \"type\": \"CITY\",\n \"value\": \"NY\"\n }\n ],\n \"delivery_address\": {\n \"address_line\": [\n \"456 Park Avenue\"\n ]\n }\n }\n }\n }\n }\n }\n ],\n \"education\":[\n {\n \"provider_ref_id\" : \"custom_value3\",\n \"school_name\":\"University of The East, Manila\",\n \"school_type\":\"college\",\n \"location_summary\":{\n \"postal_code\":\"11-22-33\",\n \"country_code\":\"US\",\n \"region\":\"NY\",\n \"municipality\":[\n {\n \"type\":\"city\",\n \"value\":\"NY\"\n }\n ]\n },\n \"degree\":{\n \"degree_type\":\"masters\",\n \"degree_major\":{\n \"name\":[\n \"Applied Physics\"\n ]\n },\n \"degree_measure\":{\n \"educational_measure\":{\n \"measure_system\":\"GPA\",\n \"measure_value\":{\n \"numeric_value\":\"2\"\n }\n }\n },\n \"degree_date\":\"2015-09-18\",\n \"degree_minor\":\"Maths\"\n },\n \"dates_of_attendance\":{\n \"start_date\":\"1997-09-16\",\n \"end_date\":\"2015-09-18\"\n },\n \"person_name\":{\n \"given_name\":\"GN1\",\n \"middle_name\":\"MN1\",\n \"family_name\":\"FN1\",\n \"type\":\"subject\"\n }\n }\n ],\n \"references\":[\n {\n \"provider_ref_id\" : \"custom_value4\",\n \"person_name\":{\n \"given_name\":\"GN1\",\n \"family_name\":\"FN1\",\n \"type\":\"subject\"\n },\n \"reference_type\":\"reference type\",\n \"postal_address\":{\n \"country_code\":\"US\",\n \"region\":\"NY\",\n \"municipality\":[\n {\n \"type\":\"city\",\n \"value\":\"NY\"\n }\n ]\n },\n \"years_acquainted\":\"1\",\n \"contact_info\":{\n \"contact_method\":{\n \"telephone\":[\n {\n \"number\":\"(654)654-6546\",\n \"type\":\"work\"\n }\n ]\n }\n }\n }\n ],\n \"criminal_history\":[\n {\n \"provider_ref_id\" : \"custom_value5\",\n \"charge_or_complaint\":\"Shoplifting\",\n \"charge_type_classification\":\"misdemeanor\",\n \"charge_description\":\"Stole $50 of merchandise\",\n \"charge_date\":\"2012-03-01\",\n \"charge_address\":{\n \"region\":\"GA\",\n \"municipality\":[\n {\n \"type\":\"CITY\",\n \"value\":\"Atlanta\"\n },\n {\n \"type\":\"COUNTY\",\n \"value\":\"Fulton\"\n }\n ]\n },\n \"offense_date\":\"2012-03-13\",\n \"arrest_date\":\"2012-03-13\",\n \"disposition_date\":\"2012-03-22\",\n \"disposition\":\"Released with misdemeanor/ no prior convictions\"\n }\n ]\n }\nSuccess code with candidate id in location header.
\n+ Headers\n\n location:/candidate/1230d450-1379-11e7-b946-2a4020524153\n\n+ Attributes (Candidate response)\n\n+ Body\n\n {\n \"candidate_id\": \"1230d450-1379-11e7-b946-2a4020524153\"\n }\nError code for bad request.
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"400\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nError code for aunthentication required.
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"401\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nError code for forbidden action.
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"403\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nid (string, optional) - The internal generated id for the candidate's.override_candidate_data (enum[string], optional) - Flag to replace candidate data. true - will update if candidate already exists.true - will update the candidate if candidate already exists else will create a new one. false - will throw a 409 error if candidate already exists else will create a new one.persons (array[Person], required) - A collection of person name details.email (string, optional) - The candidate's preferred contact email.phones (array[Phone], optional) - A collection of candidate's phone numbers.dob (string, optional) - The candidate's Date of birth. date format: yyyy-MM-ddgender (enum[string], optional) - The candidate's gender.malefemaleotherunspecifiedidentities (Identities, optional) addresses (array[Address], optional) - A collection of candidate's addresses.employers (array[Employer], optional) - A collection of employer's details.education (array[Education], optional) - A collection of education details.references (array[Reference], optional) - A collection of references details.criminal_history (array[criminalhistorydata], optional) - A collection of candidate's criminal recordsgiven_name (string, required) middle_name (string, optional) family_name (string, required) maiden_name (string, optional) suffix (string, optional) father_name (string, optional) mother_name (string, optional) mother_maiden_name (string, optional) local_lang_name (string, optional) salutation (string, optional) has_middle_name (string, optional) type (enum[string], required) - Specifies the type in case of candidate having multiple names. Person with type subject is required.subjectmaidenaliasothercountry_code (string, optional) - Specifies country code. Default is +1extension (string, optional) - Specifies extensionnumber (string, required) - Specifies 10 digit phone numbertype (enum[string], optional) - Specifies the priority of phone number. Default should be kept as primaryprimaryalternatelicenses (array[License], optional) - A list of licenses available.government_ids (GovernmentIds, optional)provider_ref_id (string, optional) - custom reference id to be used by the clientlicense_name (enum[string], optional) - The type of license.cerfaaindlicmvrinsDRIVER_LICENSE_IDPASSPORTGOVTNPI_IDHDEAHLICHSCSHORCtype (enum[string], optional) - The type of license.CommercialNon-CommercialNurseAideHealthcareProviderPERMANENTTEMPORARYGUESTOTHERN/Anumber (string, optional) - The license number.state (string, optional) - The license issue state. For United States, a 2 letter code is acceptable.country: US (string, optional) - The license issue country.use_for_add_ons (enum[string], optional) - optional add-on indicator for screening section. Values allowed true or false.truelicense_agency (string, optional) - Agency name that issued the license.candidate_name (string, optional) - Name of the Candidate on the license. By default, family name of given Candidate gets mappedlicense_description (string, optional) - Description about the license.hasSSN (string, optional) - Y or N to indicate SSN information provided or not.hasUAN (string, optional) - Y or N to indicate UAN information provided or not.ids (array[Id], optional) - Government IDs like SSN, Passport and other country specific.type (enum[string], optional) - The type of Id.SSNPASSPORTGOVTSINSNBMONITORING-DLUANnumber (string, optional) - Id number.country (string, optional) - Id issued country.issue_date (string, optional) - Id issue date. suggested format: yyyy-MM-ddexpiry_date (string, optional) - Id expiry date. suggested format: yyyy-MM-ddid_type_code (enum[string], optional) - The type of Identity code.LASTAAD - can be used for Aadhaar cardPERMACTNBdescription (string, optional) - Details about the Id typestreet_address (string, optional) - The delivery address line 1.street_address2 (string, optional) - The delivery address line 2.city (string, optional) - The city or area of the given address.state (string, optional) - The state or region of the candidate. For United States, a 2 letter code is acceptable. e.g UScountry (string, optional) - The country of residence of the address.zip_code (string, optional) - The zip or postal code of the address.start_at (string, optional) - The date of start of residence. date format: yyyy-MM-dd where dd is optionalend_at (string, optional) - The date of end of residence. When absent or set to null indicates current residence. date format: yyyy-MM-dd where dd is optionalis_permanent (string, optional) - specify value as Yes or No if it is a permanent address.provider_ref_id (string, optional) - custom reference id to be used by the clientemployer_name (string, required) local_lang_employer_name (string, optional) employee_id (string, optional) employer_address (EmployerAddress, optional) title (string, optional) department (string, optional) dates_of_employment (array[DatesOfEmployment], optional) compensation (array[Compensation], optional) contact_info (ContactInfo, optional) supervisor (Supervisor, optional) reason_for_leaving (string, optional) permission_to_contact (enum[string], optional) - values allowed true or false.truefalsebusiness_type (string, optional) ptc_override_flag (enum[string], optional) - values allowed true or false.truefalsejob_type (string, optional) contact_date (string, optional) - date format: yyyy-MM-dd where dd is optionalagency (string, optional) duties (string, optional) type (string, optional) use_for_add_ons (enum[string], optional) - optional add-on indicator for screening section. values allowed true or false.truefalsecountry_code (string, optional) postal_code (string, optional) region (string, optional) municipality (array[Municipality], optional) delivery_address (DeliveryAddress, optional) start_at (string, optional) - suggested format: yyyy-MM-ddend_at (string, optional) - suggested format: yyyy-MM-ddtype (enum[string], optional) - Specifies the address typecurrentpriorhukoubirthtype (enum[string], optional) CITYCOUNTRYOTHERvalue (string, optional)address_line (array[string], optional)location (string, optional) start_at (string, optional) - suggested format: yyyy-MM-ddend_at (string, optional) - suggested format: yyyy-MM-ddinterval_type (string, optional) currency (string, optional) value (string, optional) when (string, optional)person_name (string, optional) internet_email_address (string, optional) website (string, optional) contact_method (ContactMethod, required)telephone (array[Telephone], optional) internet_email_address (string, optional) postal_address (EmployerAddress, optional)number (string, optional) extension (string, optional) type (string, optional)supervisor_name (string, optional) supervisor_title (string, optional) supervisor_contact_info (SupervisorContactInfo, optional)person_name (string, optional) internet_email_address (string, optional) contact_method (ContactMethod, optional)provider_ref_id (string, optional) - custom reference id to be used by the clientschool_name (string, required) local_lang_school_name (string, optional) school_location (string, optional) location_summary (EmployerAddress, optional) contact_info (ContactInfo, optional) degree (Degree, optional) dates_of_attendance (DatesOfAttendance, optional) person_name (Person, optional) school_type (string, optional) use_for_add_ons (enum[string], optional) - optional add-on indicator for screening section. values allowed true or false.truefalsedegree_major (DegreeMajor, optional) degree_measure (DegreeMeasure, optional) degree_date (string, optional) - suggested format: yyyy-MM-dddegree_minor (string, optional) honors (string, optional) other_honors (string, optional) degree_type (string, optional)name (array[string], optional)educational_measure (EducationalMeasure, optional)measure_system (string, optional) measure_value (MeasureValue, optional) highest_possible_value (string, optional)numeric_value (string, optional)location (string, optional) start_date (string, optional) - suggested format: yyyy-MM-ddend_date (string, optional) - suggested format: yyyy-MM-ddprovider_ref_id (string, optional) - custom reference id to be used by the clientperson_name (Person, optional) reference_type (string, optional) postal_address (EmployerAddress, optional) years_acquainted (string, optional) contact_info (ContactInfo, optional)provider_ref_id (string, optional) - custom reference id to be used by the clientcharge_or_complaint (string, optional) - Criminal charge or complaint - example: ASSAULTcharge_type_classification (enum[string], optional) - The type of the criminal charge.felonyforfeitureinfractionmisdemeanorpettyOffencesummarytrafficviolationcapiasshowCauseordinanceViolationsealedfelonyReducedToMisdemeanormisdemeanorReducedToViolationunknowncharge_description (string, optional) - Details of the charges.charge_date (string, optional) - Charge date. suggested format: yyyy-MM-dd or yyyy-MM or yyyycharge_address (simpleaddress, optional) offense_date (string, optional) - Offense date. suggested format: yyyy-MM-dd or yyyy-MM or yyyyarrest_date (string, optional) - Arrest date. suggested format: yyyy-MM-dd or yyyy-MM or yyyydisposition_date (string, optional) - Disposition date. suggested format: yyyy-MM-dd or yyyy-MM or yyyydisposition (string, optional) - Details of the disposition.region (string, optional) municipality (array[MunicipalityType], optional)type (enum[string], optional) CITYCOUNTYOTHERvalue (string, optional)candidate_id (string, required)code (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)Retrieve a candidate by ID
\nA 404 means that the candidate for the ID is not found.
\n+ Body\n\n {\n \"code\": \"404\",\n \"message\": \"Candidate id not found.\",\n \"occurred_at\": \"Mon Feb 05 09:08:44 UTC 2018\",\n \"cause\": \"Wrong candidate id.\",\n \"recommendation\": \"Review\"\n }\nid (string, optional) - The internal generated id for the candidate's.override_candidate_data (enum[string], optional) - Flag to replace candidate data. true - will update if candidate already exists.true - will update the candidate if candidate already exists else will create a new one. false - will throw a 409 error if candidate already exists else will create a new one.persons (array[Person], required) - A collection of person name details.email (string, optional) - The candidate's preferred contact email.phones (array[Phone], optional) - A collection of candidate's phone numbers.dob (string, optional) - The candidate's Date of birth. date format: yyyy-MM-ddgender (enum[string], optional) - The candidate's gender.malefemaleotherunspecifiedidentities (Identities, optional) addresses (array[Address], optional) - A collection of candidate's addresses.employers (array[Employer], optional) - A collection of employer's details.education (array[Education], optional) - A collection of education details.references (array[Reference], optional) - A collection of references details.criminal_history (array[criminalhistorydata], optional) - A collection of candidate's criminal recordsgiven_name (string, required) middle_name (string, optional) family_name (string, required) maiden_name (string, optional) suffix (string, optional) father_name (string, optional) mother_name (string, optional) mother_maiden_name (string, optional) local_lang_name (string, optional) salutation (string, optional) has_middle_name (string, optional) type (enum[string], required) - Specifies the type in case of candidate having multiple names. Person with type subject is required.subjectmaidenaliasothercountry_code (string, optional) - Specifies country code. Default is +1extension (string, optional) - Specifies extensionnumber (string, required) - Specifies 10 digit phone numbertype (enum[string], optional) - Specifies the priority of phone number. Default should be kept as primaryprimaryalternatelicenses (array[License], optional) - A list of licenses available.government_ids (GovernmentIds, optional)provider_ref_id (string, optional) - custom reference id to be used by the clientlicense_name (enum[string], optional) - The type of license.cerfaaindlicmvrinsDRIVER_LICENSE_IDPASSPORTGOVTNPI_IDHDEAHLICHSCSHORCtype (enum[string], optional) - The type of license.CommercialNon-CommercialNurseAideHealthcareProviderPERMANENTTEMPORARYGUESTOTHERN/Anumber (string, optional) - The license number.state (string, optional) - The license issue state. For United States, a 2 letter code is acceptable.country: US (string, optional) - The license issue country.use_for_add_ons (enum[string], optional) - optional add-on indicator for screening section. Values allowed true or false.truelicense_agency (string, optional) - Agency name that issued the license.candidate_name (string, optional) - Name of the Candidate on the license. By default, family name of given Candidate gets mappedlicense_description (string, optional) - Description about the license.hasSSN (string, optional) - Y or N to indicate SSN information provided or not.hasUAN (string, optional) - Y or N to indicate UAN information provided or not.ids (array[Id], optional) - Government IDs like SSN, Passport and other country specific.type (enum[string], optional) - The type of Id.SSNPASSPORTGOVTSINSNBMONITORING-DLUANnumber (string, optional) - Id number.country (string, optional) - Id issued country.issue_date (string, optional) - Id issue date. suggested format: yyyy-MM-ddexpiry_date (string, optional) - Id expiry date. suggested format: yyyy-MM-ddid_type_code (enum[string], optional) - The type of Identity code.LASTAAD - can be used for Aadhaar cardPERMACTNBdescription (string, optional) - Details about the Id typestreet_address (string, optional) - The delivery address line 1.street_address2 (string, optional) - The delivery address line 2.city (string, optional) - The city or area of the given address.state (string, optional) - The state or region of the candidate. For United States, a 2 letter code is acceptable. e.g UScountry (string, optional) - The country of residence of the address.zip_code (string, optional) - The zip or postal code of the address.start_at (string, optional) - The date of start of residence. date format: yyyy-MM-dd where dd is optionalend_at (string, optional) - The date of end of residence. When absent or set to null indicates current residence. date format: yyyy-MM-dd where dd is optionalis_permanent (string, optional) - specify value as Yes or No if it is a permanent address.provider_ref_id (string, optional) - custom reference id to be used by the clientemployer_name (string, required) local_lang_employer_name (string, optional) employee_id (string, optional) employer_address (EmployerAddress, optional) title (string, optional) department (string, optional) dates_of_employment (array[DatesOfEmployment], optional) compensation (array[Compensation], optional) contact_info (ContactInfo, optional) supervisor (Supervisor, optional) reason_for_leaving (string, optional) permission_to_contact (enum[string], optional) - values allowed true or false.truefalsebusiness_type (string, optional) ptc_override_flag (enum[string], optional) - values allowed true or false.truefalsejob_type (string, optional) contact_date (string, optional) - date format: yyyy-MM-dd where dd is optionalagency (string, optional) duties (string, optional) type (string, optional) use_for_add_ons (enum[string], optional) - optional add-on indicator for screening section. values allowed true or false.truefalsecountry_code (string, optional) postal_code (string, optional) region (string, optional) municipality (array[Municipality], optional) delivery_address (DeliveryAddress, optional) start_at (string, optional) - suggested format: yyyy-MM-ddend_at (string, optional) - suggested format: yyyy-MM-ddtype (enum[string], optional) - Specifies the address typecurrentpriorhukoubirthtype (enum[string], optional) CITYCOUNTRYOTHERvalue (string, optional)address_line (array[string], optional)location (string, optional) start_at (string, optional) - suggested format: yyyy-MM-ddend_at (string, optional) - suggested format: yyyy-MM-ddinterval_type (string, optional) currency (string, optional) value (string, optional) when (string, optional)person_name (string, optional) internet_email_address (string, optional) website (string, optional) contact_method (ContactMethod, required)telephone (array[Telephone], optional) internet_email_address (string, optional) postal_address (EmployerAddress, optional)number (string, optional) extension (string, optional) type (string, optional)supervisor_name (string, optional) supervisor_title (string, optional) supervisor_contact_info (SupervisorContactInfo, optional)person_name (string, optional) internet_email_address (string, optional) contact_method (ContactMethod, optional)provider_ref_id (string, optional) - custom reference id to be used by the clientschool_name (string, required) local_lang_school_name (string, optional) school_location (string, optional) location_summary (EmployerAddress, optional) contact_info (ContactInfo, optional) degree (Degree, optional) dates_of_attendance (DatesOfAttendance, optional) person_name (Person, optional) school_type (string, optional) use_for_add_ons (enum[string], optional) - optional add-on indicator for screening section. values allowed true or false.truefalsedegree_major (DegreeMajor, optional) degree_measure (DegreeMeasure, optional) degree_date (string, optional) - suggested format: yyyy-MM-dddegree_minor (string, optional) honors (string, optional) other_honors (string, optional) degree_type (string, optional)name (array[string], optional)educational_measure (EducationalMeasure, optional)measure_system (string, optional) measure_value (MeasureValue, optional) highest_possible_value (string, optional)numeric_value (string, optional)location (string, optional) start_date (string, optional) - suggested format: yyyy-MM-ddend_date (string, optional) - suggested format: yyyy-MM-ddprovider_ref_id (string, optional) - custom reference id to be used by the clientperson_name (Person, optional) reference_type (string, optional) postal_address (EmployerAddress, optional) years_acquainted (string, optional) contact_info (ContactInfo, optional)provider_ref_id (string, optional) - custom reference id to be used by the clientcharge_or_complaint (string, optional) - Criminal charge or complaint - example: ASSAULTcharge_type_classification (enum[string], optional) - The type of the criminal charge.felonyforfeitureinfractionmisdemeanorpettyOffencesummarytrafficviolationcapiasshowCauseordinanceViolationsealedfelonyReducedToMisdemeanormisdemeanorReducedToViolationunknowncharge_description (string, optional) - Details of the charges.charge_date (string, optional) - Charge date. suggested format: yyyy-MM-dd or yyyy-MM or yyyycharge_address (simpleaddress, optional) offense_date (string, optional) - Offense date. suggested format: yyyy-MM-dd or yyyy-MM or yyyyarrest_date (string, optional) - Arrest date. suggested format: yyyy-MM-dd or yyyy-MM or yyyydisposition_date (string, optional) - Disposition date. suggested format: yyyy-MM-dd or yyyy-MM or yyyydisposition (string, optional) - Details of the disposition.region (string, optional) municipality (array[MunicipalityType], optional)type (enum[string], optional) CITYCOUNTYOTHERvalue (string, optional)Put json to replace or overwrite an existing candidate.
\nSuccess code with message.
\n+ Attributes (Candidate response1)\n\n\n+ Body\n\n {\n \"message\": \"candidate data updated.\"\n }\nA 404 means that the candidate for the ID is not found.
\n+ Body\n\n {\n \"code\": \"404\",\n \"message\": \"Candidate id not found.\",\n \"occurred_at\": \"Mon Feb 05 09:08:44 UTC 2018\",\n \"cause\": \"Wrong candidate id.\",\n \"recommendation\": \"Review\"\n }\nmessage (string, required)List all document types that can be used to attach for any candidate
\nAttributes (string)
\nBody
\n [\n {\n \"Country Code Required\": \"NO\",\n \"Description\": \"Curriculum vitae/ resume\",\n \"Doc-Type\": \"Resume\"\n },\n .\n .\n .\n ]\nNote: The source response example is incomplete or invalid JSON and is shown as documented.
\n","urlObject":{"protocol":"https","path":["api","v1.1","candidate","docTypes"],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"48d88ec5-c892-4c88-b61f-0d17aec7777e","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/candidate/docTypes"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Country Code Required\": \"NO\",\n \"Description\": \"Curriculum vitae/ resume\",\n \"Doc-Type\": \"Resume\"\n },\n .\n .\n .\n]"}],"_postman_id":"b2f573b8-96d8-492e-bea2-89120effe91e"},{"name":"attach documents at personal data level","id":"3201299b-e039-419b-8bde-5257ead1f358","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"Resume or Authorization"}],"url":"https://rest.fadv.com/api/v1.1/candidate//binary","description":"Attach documents for a given candidate id.\nThis endpoint allows users to attach Resume and Authorization documents at personal data level for any candidate.
\nHeaders
\n Authorization: \n doc-type: Resume or Authorization\nAttributes (Candidate Binary response)
\nBody
\n {\n \"documentid\": \"0xxx7c00-xxxx-00e9-xxxx-0200ac110004\",\n \"success\": \"true\"\n }\nBad Request
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"400\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nAdd error message
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"401\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nAdd error message
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"404\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nAdd error message
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"500\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\ndocumentid: 0xxx7c00-xxxx-00e9-xxxx-0200ac110004 (string, required) success: true (string, required)code (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)Select form-data or binary in Postman and provide the document according to the API documentation. The export does not specify a form field name.
\n","urlObject":{"protocol":"https","path":["api","v1.1","candidate","","binary"],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"04ba20bb-bc2c-4013-b3f8-f8b365771467","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"Resume or Authorization"}],"url":"https://rest.fadv.com/api/v1.1/candidate//binary"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"documentid\": \"0xxx7c00-xxxx-00e9-xxxx-0200ac110004\",\n \"success\": \"true\"\n}"},{"id":"8bb80759-2a2b-4db6-959e-caf9d22a6421","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"Resume or Authorization"}],"url":"https://rest.fadv.com/api/v1.1/candidate//binary"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"400\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"845da22c-06c3-4064-b5f9-5d9b86085752","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"Resume or Authorization"}],"url":"https://rest.fadv.com/api/v1.1/candidate//binary"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"401\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"0fe93f9a-48b2-4dee-8754-43c455820b5d","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"Resume or Authorization"}],"url":"https://rest.fadv.com/api/v1.1/candidate//binary"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"404\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"f09ff77c-6ca5-4e60-89e7-d98b890532f7","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"Resume or Authorization"}],"url":"https://rest.fadv.com/api/v1.1/candidate//binary"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"500\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"}],"_postman_id":"3201299b-e039-419b-8bde-5257ead1f358"},{"name":"attach documents at element data level","id":"140aff12-d58e-4206-b20e-f13a37dcbf4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"DegreeCertificate or any other doc type supported"}],"url":"https://rest.fadv.com/api/v1.1/candidate//element//binary","description":"Attach documents for a given candidate id.\nThis endpoint supports element level providerRefId for document upload for a given candidate.\nValue for providerRefId must be same as provided while creating candidate.
\nHeaders
\n Authorization: \n doc-type: DegreeCertificate or any other doc type supported\nAttributes (Candidate Binary response)
\nBody
\n {\n \"documentid\": \"0xxx7c00-xxxx-00e9-xxxx-0200ac110004\",\n \"success\": \"true\"\n }\nBad Request
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"400\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nAdd error message
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"401\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nAdd error message
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"404\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nAdd error message
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"500\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\ndocumentid: 0xxx7c00-xxxx-00e9-xxxx-0200ac110004 (string, required) success: true (string, required)code (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)Select form-data or binary in Postman and provide the document according to the API documentation. The export does not specify a form field name.
\n","urlObject":{"protocol":"https","path":["api","v1.1","candidate","","element","","binary"],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"219dd962-b6a7-4e44-a609-dbd6440500f4","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"DegreeCertificate or any other doc type supported"}],"url":"https://rest.fadv.com/api/v1.1/candidate//element//binary"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"documentid\": \"0xxx7c00-xxxx-00e9-xxxx-0200ac110004\",\n \"success\": \"true\"\n}"},{"id":"ed56cb96-8afb-43b6-a732-c8529187d66c","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"DegreeCertificate or any other doc type supported"}],"url":"https://rest.fadv.com/api/v1.1/candidate//element//binary"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"400\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"66611924-7ed1-43fc-889a-66e7017b87a9","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"DegreeCertificate or any other doc type supported"}],"url":"https://rest.fadv.com/api/v1.1/candidate//element//binary"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"401\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"025fa023-80ea-471c-963f-b19e38f31467","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"DegreeCertificate or any other doc type supported"}],"url":"https://rest.fadv.com/api/v1.1/candidate//element//binary"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"404\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"432e8c30-cddf-4408-904f-5e9a1d81aa4d","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"DegreeCertificate or any other doc type supported"}],"url":"https://rest.fadv.com/api/v1.1/candidate//element//binary"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"500\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"}],"_postman_id":"140aff12-d58e-4206-b20e-f13a37dcbf4c"},{"name":"attach documents with country code","id":"ca9a60e8-e2a6-4e68-a0ac-0afbbc96b0b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"PanCard or any other doc type which requires country code"}],"url":"https://rest.fadv.com/api/v1.1/candidate//countryCd//binary","description":"Attach documents for a given candidate id.\nThis endpoint supports country code for document upload for a given candidate.\nValue for country code must be 2 letter ISO code.
\nHeaders
\n Authorization: \n doc-type: PanCard or any other doc type which requires country code\nAttributes (Candidate Binary response)
\nBody
\n {\n \"documentid\": \"0xxx7c00-xxxx-00e9-xxxx-0200ac110004\",\n \"success\": \"true\"\n }\nBad Request
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"400\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nAdd error message
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"401\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nAdd error message
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"404\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nAdd error message
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"500\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\ndocumentid: 0xxx7c00-xxxx-00e9-xxxx-0200ac110004 (string, required) success: true (string, required)code (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)Select form-data or binary in Postman and provide the document according to the API documentation. The export does not specify a form field name.
\n","urlObject":{"protocol":"https","path":["api","v1.1","candidate","","countryCd","","binary"],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"975b196b-39a6-4827-9db5-2db072c7fb14","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"PanCard or any other doc type which requires country code"}],"url":"https://rest.fadv.com/api/v1.1/candidate//countryCd//binary"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"documentid\": \"0xxx7c00-xxxx-00e9-xxxx-0200ac110004\",\n \"success\": \"true\"\n}"},{"id":"4777e084-f458-4d00-8e4d-5a16a7e98128","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"PanCard or any other doc type which requires country code"}],"url":"https://rest.fadv.com/api/v1.1/candidate//countryCd//binary"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"400\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"a8fa982c-f62d-4d4f-96f5-9c05a835b261","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"PanCard or any other doc type which requires country code"}],"url":"https://rest.fadv.com/api/v1.1/candidate//countryCd//binary"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"401\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"e6f207a1-1728-43b7-befb-a5d96290087a","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"PanCard or any other doc type which requires country code"}],"url":"https://rest.fadv.com/api/v1.1/candidate//countryCd//binary"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"404\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"7f8118fa-2d04-4a7c-a30b-4a6fd4199394","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"PanCard or any other doc type which requires country code"}],"url":"https://rest.fadv.com/api/v1.1/candidate//countryCd//binary"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"500\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"}],"_postman_id":"ca9a60e8-e2a6-4e68-a0ac-0afbbc96b0b8"},{"name":"attach documents at element level with country code","id":"05791f40-2bae-42ec-b7af-fac9f83144f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"Marksheet or any other doc type which requires both provider ref id and country code"}],"url":"https://rest.fadv.com/api/v1.1/candidate//element//countryCd//binary","description":"Attach documents for a given candidate id.\nThis endpoint allows to attach document at element level with country code for a given candidate.\nValue for providerRefId must be same as provided while creating candidate.\nValue for country code must be 2 letter ISO code.
\nHeaders
\n Authorization: \n doc-type: Marksheet or any other doc type which requires both provider ref id and country code\nAttributes (Candidate Binary response)
\nBody
\n {\n \"documentid\": \"0xxx7c00-xxxx-00e9-xxxx-0200ac110004\",\n \"success\": \"true\"\n }\nBad Request
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"400\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nAdd error message
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"401\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nAdd error message
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"404\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nAdd error message
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"500\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\ndocumentid: 0xxx7c00-xxxx-00e9-xxxx-0200ac110004 (string, required) success: true (string, required)code (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)Select form-data or binary in Postman and provide the document according to the API documentation. The export does not specify a form field name.
\n","urlObject":{"protocol":"https","path":["api","v1.1","candidate","","element","","countryCd","","binary"],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"3ee2acb7-10dc-4dfb-9842-b5eee5bfaff7","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"Marksheet or any other doc type which requires both provider ref id and country code"}],"url":"https://rest.fadv.com/api/v1.1/candidate//element//countryCd//binary"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"documentid\": \"0xxx7c00-xxxx-00e9-xxxx-0200ac110004\",\n \"success\": \"true\"\n}"},{"id":"2845b831-1ed8-4faf-a173-a490a8e3bf80","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"Marksheet or any other doc type which requires both provider ref id and country code"}],"url":"https://rest.fadv.com/api/v1.1/candidate//element//countryCd//binary"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"400\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"36949903-b98e-4414-bd1b-4687d63c4bed","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"Marksheet or any other doc type which requires both provider ref id and country code"}],"url":"https://rest.fadv.com/api/v1.1/candidate//element//countryCd//binary"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"401\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"50a6e8fb-d29b-422e-8720-356ee7be3f8f","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"Marksheet or any other doc type which requires both provider ref id and country code"}],"url":"https://rest.fadv.com/api/v1.1/candidate//element//countryCd//binary"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"404\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"b97c0298-d4e9-475a-902f-d5534aee4803","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"doc-type","value":"Marksheet or any other doc type which requires both provider ref id and country code"}],"url":"https://rest.fadv.com/api/v1.1/candidate//element//countryCd//binary"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"500\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"}],"_postman_id":"05791f40-2bae-42ec-b7af-fac9f83144f8"},{"name":"attachments for a candidate","id":"d2eeaa30-be65-4e13-97e5-be2248393d5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/candidate//attachments","description":"Retrieve document attachments for a candidate by ID
\nHeaders
\n Authorization: \nAdd error message
\n+ Attributes (commonerror)\n\n\n+ Body\n\n {\n \"code\": \"404\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Apr 02 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nfileName: testFile.txt (string, required) fileSize: 24 (string, required) uploaded_at: Mon Aug 27 06:50:12 GMT 2018 (string, required) documentType: Resume (string, required) documentTypeId: some value (string, required) documentId: 560668 (string, required) fileContentType: text/plain (string, required)code (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)Retrieve monitoring product details for a candidate by ID
\nHeaders
\n Authorization: \nAttributes (string)
\nBody
\n [\n {\n \"enrollment_id\": \"xxxx..\",\n \"product_type\": \"HEALTHCARE_OIG+SAM\",\n \"timestamp\": \"2019-05-13 20:15:59.855\"\n },\n .\n .\n .\n ]\nNote: The source response example is incomplete or invalid JSON and is shown as documented.
\nAttributes (ResponseError1)
\nBody
\n {\n \"code\": \"404\",\n \"message\": \"Resource not found.\",\n \"occurred_at\": \"Tue Dec 11 12:10:14 GMT 2018\",\n \"cause\": \"Bad Request\",\n \"recommendation\": \"Review\"\n }\nAttributes (ResponseError1)
\nBody
\n {\n \"code\": \"500\",\n \"message\": \"custom message\",\n \"occurred_at\": \"Wed Nov 28 09:17:25 GMT 2018\",\n \"cause\": \"custom message\",\n \"recommendation\": \"Report\"\n }\ncode (string, required) message (string, required) occurred_at (string, required) cause (string, required) recommendation (string, required)id (string, required)
\naccount (string, required)
\nProxy to GET monitoring enrollments for a candidate by account
\nid (string, required)
\naccount (string, required)
\nuser (string, required)
\nProxy to GET monitoring enrollments for a candidate by user
\nAbility to create and maintain Candidates.
\nThe Screening Services are performed on the Candidate.
\nActions Supported:
\nNote -
\nA new field called provider_ref_id (custom reference id) has been introduced \nunder following elements : identities/licenses, employers, education, references, criminal_history
\nThis new field provider_ref_id (custom reference id) will allow users to attach document at element level while creating orders.
\n","_postman_id":"29953789-1fa6-48c5-8294-6b5476aac1c7"},{"name":"Invite","item":[{"name":"Invite - By Package Id","id":"75bc0d21-50a7-45a3-9f3d-8b6f4b7c7d5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"candidate_id\":\"test candidate id\",\n \"package_id\": \"0000\",\n \"employment_start_date\": \"2021-08-30\",\n \"position_locations\": [\n {\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"country\": \"US\"\n }\n ],\n \"client_references\": [\n \"SFApplicant_1\",\n \"SFRequsitionId_162\"\n ],\n \"user_defined_fields\": [\n \"FIN-DIR\",\n \"Alliances (ALNCE)\",\n \"USD\"\n ],\n \"quote_backs\": [\n {\n \"name\": \"test-1\",\n \"value\": \"value-1\"\n }\n ],\n \"locale\": {\n \"language_code\": \"en\",\n \"country_code\": \"us\"\n },\n \"additional_attributes\": {\n \"order_as\": { \n \"account_id\": \"000000RT\",\n \"user_id\": \"REST\",\n \"email\": \"test mail@fadv.com\"\n }\n },\n \"documents\": [\n {\n \"document_id\": \"000000\",\n \"type\": \"2\"\n }\n ] \n}","options":{"raw":{"language":"json"}}},"url":"https://rest.fadv.com/api/v1.1/invite","description":"The recruiter initiates a request for the candidate to complete an application.
\nHeaders
\n Authorization: \nAttributes (candidateinviterequest)
\nBody
\n {\n \"candidate_id\":\"test candidate id\",\n \"package_id\": \"0000\",\n \"employment_start_date\": \"2021-08-30\",\n \"position_locations\": [\n {\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"country\": \"US\"\n }\n ],\n \"client_references\": [\n \"SFApplicant_1\",\n \"SFRequsitionId_162\"\n ],\n \"user_defined_fields\": [\n \"FIN-DIR\",\n \"Alliances (ALNCE)\",\n \"USD\"\n ],\n \"quote_backs\": [\n {\n \"name\": \"test-1\",\n \"value\": \"value-1\"\n }\n ],\n \"locale\": {\n \"language_code\": \"en\",\n \"country_code\": \"us\"\n },\n \"additional_attributes\": {\n \"order_as\": { \n \"account_id\": \"000000RT\",\n \"user_id\": \"REST\",\n \"email\": \"test mail@fadv.com\"\n }\n },\n \"documents\": [\n {\n \"document_id\": \"000000\",\n \"type\": \"2\"\n }\n ] \n }\nBad request
\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\ncandidate_id (string, required) - candidate_id from Candidate APIpackage_id (string, required) - The specific search package being requested in the order once the candidate submits the application.employment_start_date (string, optional) - The employment start date for the applicant.position_applied_for (string, optional) - name of the position to applyposition_locations (array[positionlocationasType], optional)notification_url (string, optional) - webhook URL for status notificationsclient_references (array[string], optional) user_defined_fields (array[string], optional)quote_backs (array[quotebacktype], optional) locale (localetype, optional) - Locale consists of at least a language identifier and a region identifier.additional_attributes (additionalattributesasType, optional) - Additional attributescandidate_type (string, optional) - Candidate type. Value is case-sensitive.documents (array[documentitemtype], optional) - array of document id's available for a candidateDetails of the position
\ncity (string, optional) - Position in the citystate (string, optional) - Position in the statecountry (string, optional) - Position in the countryname (string, required) value (string, required)language_code (string, optional) country_code (string, optional)Requestor Detail
\norder_as (orderas, optional) - Ordering Account detailssystem: EA (string, optional) - System where order is to be createdaccount_id (string) - Requested account Iduser_id (string) - Requested user Idemail (string) - Requested email Iddocument id reference for invite
\ndocument_id (string, required) - document id for referencetype (string, required) - doc type of a document. Eg.- mention type value as 2 for Authorization and 144 for Resumeapplicant_id (object, required) - Unique id for each candidate.The recruiter initiates a request for the candidate to complete an application.
\nHeaders
\n Authorization: \nAttributes (candidateinviterequest1)
\nBody
\n {\n \"candidate_id\":\"test candidate id\",\n \"package_id\": \"NEW_PACKAGE\",\n \"position_locations\": [\n {\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"country\": \"US\"\n }\n ],\n \"client_references\": [\n \"SFApplicant_1\",\n \"SFRequsitionId_162\"\n ],\n \"user_defined_fields\": [\n \"FIN-DIR\",\n \"Alliances (ALNCE)\",\n \"USD\"\n ],\n \"quote_backs\": [\n {\n \"name\": \"test-1\",\n \"value\": \"value-1\"\n }\n ],\n \"locale\": {\n \"language_code\": \"en\",\n \"country_code\": \"us\"\n },\n \"additional_attributes\": {\n \"order_as\": { \n \"account_id\": \"000000RT\",\n \"user_id\": \"REST\",\n \"email\": \"test mail@fadv.com\"\n }\n },\n \"documents\": [\n {\n \"document_id\": \"000000\",\n \"type\": \"2\"\n }\n ],\n \"new_package_info\": {\n \"package_settings\": {\n \"template_id\":\"1000\",\n \"adjudication\":\"N\",\n \"pri_type\":\"PRI6\",\n \"pri_max_elements\":\"1\",\n \"edu_type\":\"EDU7\",\n \"edu_max_elements\":\"2\",\n \"emp_type\":\"EMP8\",\n \"emp_max_elements\":\"3\",\n \"references_max_elements\":\"4\"\n },\n \"components\": [\n {\n \"component_name\": \"CRIMINAL\",\n \"type\": \"INTLPRN\",\n \"sub-type\": \"US\",\n \"component_settings\": {\n \"scope_yrs\": \"5\"\n }\n } \n ]\n }\n }\nBad request
\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\ncandidate_id (string, required) - Profile Advantage candidate profile id.package_id (string, required) - The specific search package being requested in the order once the candidate submits the application.employment_start_date (string, optional) - The employment start date for the applicant.position_applied_for (string, optional) - name of the position to applyposition_locations (array[positionlocationasType], optional)notification_url (string, optional) - webhook URL for status notificationsclient_references (array[string], optional) user_defined_fields (array[string], optional)quote_backs (array[quotebacktype], optional) locale (localetype, optional) - Locale consists of at least a language identifier and a region identifier.additional_attributes (additionalattributesasType, optional) - Additional attributescandidate_type (string, optional) - Candidate type. Value is case-sensitive.documents (array[documentitemtype], optional) - array of document id's available for a candidatecopy_to_applicant (string, optional) - Applicant may request to receive a detailed results reportnew_package_info (newpackageinfo, optional) - details for new package to be createdDetails of the position
\ncity (string, optional) - Position in the citystate (string, optional) - Position in the statecountry (string, optional) - Position in the countryname (string, required) value (string, required)language_code (string, optional) country_code (string, optional)Requestor Detail
\norder_as (orderas, optional) - Ordering Account detailssystem: EA (string, optional) - System where order is to be createdaccount_id (string) - Requested account Iduser_id (string) - Requested user Idemail (string) - Requested email Iddocument id reference for invite
\ndocument_id (string, required) - document id for referencetype (string, required) - doc type of a document. Eg.- mention type value as 2 for Authorization and 144 for Resumedetails for new package to be created
\npackage_settings (packagesettingstype, optional) - settings for the packagecomponents (array[componenttype], optional) - list of componentspackage settings
\ntemplate_id (string, optional) - template idadjudication (string, optional) - adjudication consent Y or Npri_type (string, optional) - pri typepri_max_elements (string, optional) - pri max elementsedu_type (string, optional) - education typeedu_max_elements (string, optional) - max no of elementsemp_type (string, optional) - employment typeemp_max_elements (string, optional) - max no of elementsreferences_max_elements (string, optional) - max no of elementsDetails of the new component to be created
\ncomponent_name (string, optional) - name of the componenttype (string, required) - component typesub-type (string, optional) - component sub typecomponent_settings (componentsettingstype, optional) - settings for the componentoptions for the scope
\nscope_yrs (string, optional) - xchange typeapplicant_id (object, required) - Unique id for each candidate.The status request allows you to request the latest status of Candidate’s Application.
\nHeaders
\n Authorization: \nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\norder_id (object, optional) - Unique id for each order.applicant_id (object, optional) - Unique id for each candidate.status (string, optional) event (string, optional) is_rescreen (string, optional) link (string, optional) link_expiration_date (string, optional) meta_data (metadatatype, optional)Meta data submitted with order
\nclient_references (array[string], optional) user_defined_fields (array[string], optional) quote_backs (array[quotebacktype], optional)name (string, required) value (string, required)applicant_id (string, required)
\naccount (string, required)
\nHeaders
\n Authorization: \nAttributes (candidateinvitestatusresponse)
\nBody
\n {\n \"status\" : \"Not Started\",\n \"event\" : \"Applicant Invitation Email Resent\"\n }\nNo additional error description is provided.
\nNo additional error description is provided.
\nNo additional error description is provided.
\norder_id (object, optional) - Unique id for each order.applicant_id (object, optional) - Unique id for each candidate.status (string, optional) event (string, optional) is_rescreen (string, optional) link (string, optional) link_expiration_date (string, optional) meta_data (metadatatype, optional)Meta data submitted with order
\nclient_references (array[string], optional) user_defined_fields (array[string], optional) quote_backs (array[quotebacktype], optional)name (string, required) value (string, required)applicant_id (string, required)
\naccount (string, required)
\nuser (string, required)
\nHeaders
\n Authorization: \nAttributes (candidateinvitestatusresponse)
\nBody
\n {\n \"status\" : \"Not Started\",\n \"event\" : \"Applicant Invitation Email Resent\"\n }\nNo additional error description is provided.
\nNo additional error description is provided.
\nNo additional error description is provided.
\norder_id (object, optional) - Unique id for each order.applicant_id (object, optional) - Unique id for each candidate.status (string, optional) event (string, optional) is_rescreen (string, optional) link (string, optional) link_expiration_date (string, optional) meta_data (metadatatype, optional)Meta data submitted with order
\nclient_references (array[string], optional) user_defined_fields (array[string], optional) quote_backs (array[quotebacktype], optional)name (string, required) value (string, required)The viewlink request allows you to request a secure link to access to the applicant view in enterprise edition.
\nHeaders
\n Authorization: \nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\n","urlObject":{"protocol":"https","path":["api","v1.1","invite","","viewlink"],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"ad176e35-f255-4346-bee2-b2444fd31b4f","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"46c0eb28-3d22-4d63-82da-4c56b09b3006","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b834caea-6fa1-40ef-90a2-ebf60b9bda4b","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"225dc000-3fee-48d2-954b-c8d3bc2349c2","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5433d9a8-ecb2-4433-aab6-e6f750802804"},{"name":"InviteViewlinkViewAccountByApplicantId","id":"f3eab14e-93df-49fc-90fb-f1ee2ed8b7b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink/viewAccount/","description":"applicant_id (string, required)
\naccount (string, required)
\nHeaders
\n Authorization: \nAttributes (string)
\nBody
\n {\n \"link\" : \" https://screentest.First Advantage.com/pub/l/viewCandidateLink?key=\"\n }\nNo additional error description is provided.
\nNo additional error description is provided.
\nNo additional error description is provided.
\n","urlObject":{"protocol":"https","path":["api","v1.1","invite","","viewlink","viewAccount",""],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"efe670f3-281b-454b-8240-e707306dbd79","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink/viewAccount/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"link\" : \" https://screentest.First Advantage.com/pub/l/viewCandidateLink?key=\"\n}"},{"id":"da71d464-3759-4148-a468-8fbc91f7dc3e","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink/viewAccount/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c87f7fd4-724b-4c81-956f-b3a18c6d5474","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink/viewAccount/"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6d3d86a2-a637-427f-8d10-dd2757dd71f1","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink/viewAccount/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f3eab14e-93df-49fc-90fb-f1ee2ed8b7b6"},{"name":"InviteViewlinkViewAccountViewUserUser","id":"4a17a822-b0f5-4039-a26c-ba97d0556adf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink/viewAccount//viewUser/","description":"applicant_id (string, required)
\naccount (string, required)
\nuser (string, required)
\nHeaders
\n Authorization: \nAttributes (string)
\nBody
\n {\n \"link\" : \" https://screentest.First Advantage.com/pub/l/viewCandidateLink?key=\"\n }\nNo additional error description is provided.
\nNo additional error description is provided.
\nNo additional error description is provided.
\n","urlObject":{"protocol":"https","path":["api","v1.1","invite","","viewlink","viewAccount","","viewUser",""],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"c31870f3-fe44-4517-bd98-c306aae0b86e","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink/viewAccount//viewUser/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"link\" : \" https://screentest.First Advantage.com/pub/l/viewCandidateLink?key=\"\n}"},{"id":"97087e53-1f48-4451-8837-050f6be220d1","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink/viewAccount//viewUser/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"9124078b-a3c2-450b-8a4a-4e1498fb9c7b","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink/viewAccount//viewUser/"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"0200fb61-ea77-48b7-ae22-628b15979cfb","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/invite//viewlink/viewAccount//viewUser/"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4a17a822-b0f5-4039-a26c-ba97d0556adf"},{"name":"GET Invite Documents By Applicant Id","id":"e51ae3b4-438d-40f6-accc-80ac442e1a7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://rest.fadv.com/api/v1.1/invite//documents","description":"Fetch All Invite Documents By Applicant Id
\nAttributes (array[Invite Documents response])
\nBody
\n [\n {\n \"filename\": \"Resume.csv\",\n \"name\": \"Curriculum Vitae/Resume\",\n \"description\": \"Curriculum Vitae/Resume\",\n \"id\": \"b7d69c27554ec3ae\",\n \"type\": \"application/csv\"\n }\n ]\nError code for bad request.\n + Body
\n {\n \"code\": \"400\",\n \"message\": \"custom message\",\n \"occurred_at\": \"Fri Oct 25 09:49:00 GMT 2018\",\n \"cause\": \"Bad Request\",\n \"recommendation\": \"Review\"\n }\nNo additional error description is provided.
\n+ Attributes (ResponseError)\n\n\n+ Body\n\n {\n \"error\" : \"E-104 Error occurred while processing your request\"\n }\nfilename (string, required)name (string, required) description (string, required) id (string, required) type (string, required)code (string, optional) message (string, optional)##AccountDetailsResponse (object)
\ndetails (array[AccountDetailsType], required)Account details
\naccount_id (string, required) - Account idname (string, required) - Account nameFetch All Invite Documents By Applicant Id and Order Account
\napplicant_id (string, required)
\naccount (string, required)
\nAttributes (array[Invite Documents ViewAccount response])
\nBody
\n [\n {\n \"filename\": \"Resume.csv\",\n \"name\": \"Curriculum Vitae/Resume\",\n \"description\": \"Curriculum Vitae/Resume\",\n \"id\": \"b7d69c27554ec3ae\",\n \"type\": \"application/csv\"\n }\n ]\nError code for bad request.\n + Body
\n {\n \"code\": \"400\",\n \"message\": \"custom message\",\n \"occurred_at\": \"Fri Oct 25 09:49:00 GMT 2018\",\n \"cause\": \"Bad Request\",\n \"recommendation\": \"Review\"\n }\nNo additional error description is provided.
\n+ Attributes (ResponseError)\n\n\n+ Body\n\n {\n \"error\" : \"E-104 Error occurred while processing your request\"\n }\nfilename (string, required)name (string, required) description (string, required) id (string, required) type (string, required)code (string, optional) message (string, optional)##AccountDetailsResponse (object)
\ndetails (array[AccountDetailsType], required)Account details
\naccount_id (string, required) - Account idname (string, required) - Account nameFetch document's data (binary data) by applicant id and document id
\napplicant_id (string, required)
\ndocument_id (string, required)
\nError code for bad request.\n + Body
\n {\n \"code\": \"400\",\n \"message\": \"custom message\",\n \"occurred_at\": \"Fri Oct 25 09:49:00 GMT 2018\",\n \"cause\": \"Bad Request\",\n \"recommendation\": \"Review\"\n }\nNo additional error description is provided.
\n+ Attributes (ResponseError)\n\n\n+ Body\n\n {\n \"error\" : \"Given document is not valid.\"\n }\nNo additional error description is provided.
\n+ Attributes (ResponseError)\n\n\n+ Body\n\n {\n \"error\" : \"E-104 Error occurred while processing your request\"\n }\ncode (string, optional) message (string, optional)##AccountDetailsResponse (object)
\ndetails (array[AccountDetailsType], required)Account details
\naccount_id (string, required) - Account idname (string, required) - Account nameFetch document's data (binary data) by applicant id, document id and order account
\napplicant_id (string, required)
\ndocument_id (string, required)
\naccount (string, required)
\nError code for bad request.\n + Body
\n {\n \"code\": \"400\",\n \"message\": \"custom message\",\n \"occurred_at\": \"Fri Oct 25 09:49:00 GMT 2018\",\n \"cause\": \"Bad Request\",\n \"recommendation\": \"Review\"\n }\nNo additional error description is provided.
\n+ Attributes (ResponseError)\n\n\n+ Body\n\n {\n \"error\" : \"Given document is not valid.\"\n }\nNo additional error description is provided.
\n+ Attributes (ResponseError)\n\n\n+ Body\n\n {\n \"error\" : \"E-104 Error occurred while processing your request\"\n }\ncode (string, optional) message (string, optional)##AccountDetailsResponse (object)
\ndetails (array[AccountDetailsType], required)Account details
\naccount_id (string, required) - Account idname (string, required) - Account nameAttributes (string)
\nBody
\n {\n \"message\" : \"success\"\n }\nNo additional error description is provided.
\nNo additional error description is provided.
\nAttributes (commonerror)
\nBody
\n {\n \"code\": \"{{custome error code}}\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Aug 13 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nNo additional error description is provided.
\ncode (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)applicant_id (string, required)
\naccount (string, required)
\nAttributes (string)
\nBody
\n {\n \"message\" : \"success\"\n }\nNo additional error description is provided.
\nNo additional error description is provided.
\nAttributes (commonerror)
\nBody
\n {\n \"code\": \"{{custome error code}}\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Aug 13 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nNo additional error description is provided.
\ncode (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)applicant_id (string, required)
\naccount (string, required)
\nuser (string, required)
\nemail(string, optional)
\nAttributes (string)
\nBody
\n {\n \"message\" : \"success\"\n }\nNo additional error description is provided.
\nNo additional error description is provided.
\nAttributes (commonerror)
\nBody
\n {\n \"code\": \"{{custome error code}}\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Aug 13 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nNo additional error description is provided.
\ncode (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)string, optional
\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[{"id":"149a4e13-fd62-4d00-8ca5-ae4e5d065cff","name":"200 OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//extend/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","extend","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\" : \"success\"\n}"},{"id":"64997a3b-eff4-4c81-84ca-ad74592d8b20","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//extend/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","extend","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"532636d8-2f3a-4d30-a4de-066d09377c2d","name":"404 Not Found","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//extend/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","extend","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"bdee18f4-1811-4a33-a81b-286d44503def","name":"422 Unprocessable Entity","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//extend/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","extend","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"{{custome error code}}\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Aug 13 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"783efe52-488d-47b8-acb0-83f918cc16aa","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//extend/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","extend","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ee7f74cf-7e4c-48af-8409-1fc234e3dffa"},{"name":"InviteCancelByApplicantIdPOST","id":"f742d28f-8702-449d-adbd-3b50e17881af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://rest.fadv.com/api/v1.1/invite//cancel","description":"Attributes (string)
\nBody
\n {\n \"message\" : \"success\"\n }\nNo additional error description is provided.
\nNo additional error description is provided.
\nAttributes (commonerror)
\nBody
\n {\n \"code\": \"{{custome error code}}\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Aug 13 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nNo additional error description is provided.
\ncode (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)applicant_id (string, required)
\naccount (string, required)
\nAttributes (string)
\nBody
\n {\n \"message\" : \"success\"\n }\nNo additional error description is provided.
\nNo additional error description is provided.
\nAttributes (commonerror)
\nBody
\n {\n \"code\": \"{{custome error code}}\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Aug 13 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nNo additional error description is provided.
\ncode (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)applicant_id (string, required)
\naccount (string, required)
\nuser (string, required)
\nemail(string, optional)
\nAttributes (string)
\nBody
\n {\n \"message\" : \"success\"\n }\nNo additional error description is provided.
\nNo additional error description is provided.
\nAttributes (commonerror)
\nBody
\n {\n \"code\": \"{{custome error code}}\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Aug 13 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nNo additional error description is provided.
\ncode (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)string, optional
\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[{"id":"936d0566-8dbd-4a1c-aff1-d68512a2df5d","name":"200 OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//cancel/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","cancel","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\" : \"success\"\n}"},{"id":"6551188e-a13d-4aa2-8141-33e7e6cb9119","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//cancel/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","cancel","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6170f415-5be3-451e-89d1-3357ce3331af","name":"404 Not Found","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//cancel/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","cancel","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"adf40980-c8e8-474e-88cb-490afbfa0023","name":"422 Unprocessable Entity","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//cancel/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","cancel","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"{{custome error code}}\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Aug 13 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"554a8d19-4998-4b23-85b9-2ebd6a51fca6","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//cancel/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","cancel","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"91f733ee-84b9-4f1b-886f-a4ef4b64f022"},{"name":"InviteResendByApplicantIdPOST","id":"ce854187-02a6-49a7-b36f-be489e9284ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://rest.fadv.com/api/v1.1/invite//resend","description":"Attributes (string)
\nBody
\n {\n \"message\" : \"success\"\n }\nNo additional error description is provided.
\nNo additional error description is provided.
\nAttributes (commonerror)
\nBody
\n {\n \"code\": \"{{custome error code}}\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Aug 13 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nNo additional error description is provided.
\ncode (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)applicant_id (string, required)
\naccount (string, required)
\nAttributes (string)
\nBody
\n {\n \"message\" : \"success\"\n }\nNo additional error description is provided.
\nNo additional error description is provided.
\nAttributes (commonerror)
\nBody
\n {\n \"code\": \"{{custome error code}}\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Aug 13 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nNo additional error description is provided.
\ncode (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)applicant_id (string, required)
\naccount (string, required)
\nuser (string, required)
\nemail(string, optional)
\nAttributes (string)
\nBody
\n {\n \"message\" : \"success\"\n }\nNo additional error description is provided.
\nNo additional error description is provided.
\nAttributes (commonerror)
\nBody
\n {\n \"code\": \"{{custome error code}}\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Aug 13 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n }\nNo additional error description is provided.
\ncode (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)string, optional
\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[{"id":"e26ec0e8-5624-48ea-bbf4-87cc0864f7d3","name":"200 OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//resend/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","resend","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\" : \"success\"\n}"},{"id":"36322af4-beb5-46be-b629-76eb6219366d","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//resend/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","resend","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4a318960-46b3-4b72-89b9-a3c67d0cda64","name":"404 Not Found","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//resend/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","resend","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"eb5c316d-2152-430b-92fe-6694804e8fd5","name":"422 Unprocessable Entity","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//resend/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","resend","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"{{custome error code}}\",\n \"message\": \"{{custom text}}\",\n \"occurred_at\": \"Thu Aug 13 19:59:27 IST 2020\",\n \"cause\": \"{{custom text}}\",\n \"recommendation\": \"{{custom text}}\"\n}"},{"id":"2b28aca7-4b0c-4243-a75d-55ee10ba3911","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://rest.fadv.com/api/v1.1/invite//resend/viewAccount//viewUser/","protocol":"https","host":["rest.fadv.com"],"path":["api","v1.1","invite","","resend","viewAccount","","viewUser",""],"query":[{"key":"email","value":"","description":"string, optional","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"bd2cd745-6462-4019-8210-b2ccb24bc0e0"}],"id":"68317a45-5e45-47b1-8476-052428000476","description":"The First Advantage Candidate Data Capture service is a convenient method of integrating your existing system with the First Advantage Direct Advantage or Profile Advantage systems. The goal is to use the data captured as a result of this integration and the subsequent application sent to the Candidate, to secure all data required to process a background order via the First Advantage flagship product, Enterprise Advantage. By using this integration, you can leverage the data that is entered or already maintained in your system as well as request additional information required for the background screening by triggering an application to the candidate.
\nActions Supported:
\nProvides information like accounts id and names for root accounts and their sub-accounts
\nHeaders
\n Authorization: \nAttributes (AccountDetailsResponse)
\nBody
\n [\n {\n \"account_id\": \"123123COR\",\n \"name\": \"FADV REST CORE\"\n },\n {\n \"account_id\": \"123123PPP\",\n \"name\": \"FADV REST - INTERNAL TEST\"\n }\n ]\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\nReferenced data structures not defined in the export: AccountDetailsResponse.
\n","urlObject":{"protocol":"https","path":["api","v1.1","accounts","","details"],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"31bd5d17-d896-4f33-a670-7dbe912c9aa6","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//details"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"account_id\": \"123123COR\",\n \"name\": \"FADV REST CORE\"\n },\n {\n \"account_id\": \"123123PPP\",\n \"name\": \"FADV REST - INTERNAL TEST\"\n }\n]"},{"id":"51357819-fd57-4aa9-85e5-1848cfd375e0","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//details"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6b1a0919-91a3-4a6a-ac99-676e4b3fcdb3","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//details"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"46d56359-bdf0-41a0-b312-aaaf7c2df429","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//details"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"37ce62d2-808a-41f2-85c1-3ee8964d611d"},{"name":"AccountsProfilesById","id":"1279e0c6-edbf-4801-a55f-6900180bca64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//profiles","description":"Lists all the profiles under the account.
\nHeaders
\n Authorization: \nAttributes (array[string])
\nBody
\n [\n \"TESTADMINPROFILE\",\n \"TESTRECPROFILE\",\n \"TESTXCHANGEPROFILE\"\n ]\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\n","urlObject":{"protocol":"https","path":["api","v1.1","accounts","","profiles"],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"7eb3caac-879e-43d6-8f69-b82521dea1ca","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//profiles"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"[\n \"TESTADMINPROFILE\",\n \"TESTRECPROFILE\",\n \"TESTXCHANGEPROFILE\"\n]"},{"id":"a1e02d97-ca16-4d85-8dc4-51b1c0a34baf","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//profiles"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f14547a4-1109-4771-b340-3352bb0c029a","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//profiles"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"491cb903-a997-4b1d-b47c-3b2fbb421e0b","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//profiles"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1279e0c6-edbf-4801-a55f-6900180bca64"},{"name":"AccountsUsersById","id":"8413b47f-c75f-44d9-af22-d0c3c3db5c02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//users","description":"Lists all the users under the account.
\nHeaders
\n Authorization: \nAttributes (array[UsersType])
\nBody
\n [\n {\n \"account\": \"123123COR\",\n \"user_id\": \"TEST USER7\",\n \"active\": \"true\",\n \"first_name\": \"FN\",\n \"last_name\": \"LN\"\n }\n ]\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\nfirst_name (string, required) - The first name of the user.last_name (string, required) - The last name of the user.user_id (string, required) - The user id .active (string, optional) - To activate status of the user.account (string, optional) - First Advantage assigned root account id.profile (string, optional) - First Advantage Profile id.sso_client_name (string, optional) - SSO client name.sso_client_user (string, optional) - SSO client user.id (string, required)
\npackage_id (string, required)
\nPackage information related to package id
\nHeaders
\n Authorization: \nAttributes (PackageDetailResponse)
\nBody
\n {\n \"package_details\": [\n {\n \"package_id\": \"1234\",\n \"name\": \"BUNDLE\",\n \"screenings\": [\n {\n \"type\": \"MVR\",\n \"name\": \"Motor Vehicle Report\"\n },\n {\n \"type\": \"SSNV\",\n \"name\": \"Social Security Verification\"\n }\n ]\n }\n ]\n }\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\npackage_details (array[PackageType], required)Package object schema
\nstatus (string, required) - Status of package details requestaccount (string, optional) - Account id for the package details requestpackageid (string, required) - Package id of the requestname (string, optional) - Name of the packageprice (string, optional) components (ComponentType, required) - List of components assigned to packagepreferences (PreferenceType, required) - Prefences assigned to packageerror (ErrorType, optional) - Error available any error with requestComponent object attributes
\ntype (string, required) - Name of the componentsubtype (string, optional) - Subtype of the componentsearchtype (string, optional) name (string, required) - Name of the componentscope (string, required) - Scope of the sub componentpreferences (PreferenceType, required) - Prefences assigned to packagePreference of the Package
\nid (string, optional) - Preference id mapped in the database.name (string, optional) - Preference namevalue (string, optional) - value assigned to preferenceError attributes
\ncode (string, required) - Error codedescription (string, required) - Error descriptionAll the packages under the account
\nHeaders
\n Authorization: \nAttributes (PackageDetailResponse)
\nBody
\n {\n \"package_details\": [\n {\n \"package_id\": \"1234\",\n \"name\": \"Bundle\"\n },\n {\n \"package_id\": \"5678\",\n \"name\": \"Choice\"\n }\n ]\n }\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nInternal server error
\npackage_details (array[PackageType], required)Package object schema
\nstatus (string, required) - Status of package details requestaccount (string, optional) - Account id for the package details requestpackageid (string, required) - Package id of the requestname (string, optional) - Name of the packageprice (string, optional) components (ComponentType, required) - List of components assigned to packagepreferences (PreferenceType, required) - Prefences assigned to packageerror (ErrorType, optional) - Error available any error with requestComponent object attributes
\ntype (string, required) - Name of the componentsubtype (string, optional) - Subtype of the componentsearchtype (string, optional) name (string, required) - Name of the componentscope (string, required) - Scope of the sub componentpreferences (PreferenceType, required) - Prefences assigned to packagePreference of the Package
\nid (string, optional) - Preference id mapped in the database.name (string, optional) - Preference namevalue (string, optional) - value assigned to preferenceError attributes
\ncode (string, required) - Error codedescription (string, required) - Error descriptionLists all the cancel reasons for orders under the account.
\nHeaders
\n Authorization: \nAttributes (array[string])
\nBody
\n {\n \"cancel_reasons\": [\n \"Amend self-report\",\n \"Incorrect DOB\",\n \"Incorrect Name\",\n \"Incorrect SSN\",\n \"Needs More Information\",\n \"other\"\n ]\n }\nRequest requires user authentication
\nThe server has not found anything matching the Request-URI
\nThe server has not found results
\nInternal server error
\n","urlObject":{"protocol":"https","path":["api","v1.1","accounts","","cancelReasons"],"host":["rest.fadv.com"],"query":[],"variable":[]}},"response":[{"id":"3ccc6215-18de-4dcd-91cb-7c855357b1ab","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//cancelReasons"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"cancel_reasons\": [\n \"Amend self-report\",\n \"Incorrect DOB\",\n \"Incorrect Name\",\n \"Incorrect SSN\",\n \"Needs More Information\",\n \"other\"\n ]\n}"},{"id":"0e8eeeee-eafa-4fb0-a620-15158079256a","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//cancelReasons"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"5cd58fd0-f99f-4b9a-b306-985c0dbd3bc0","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//cancelReasons"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a0c1d81e-9fc9-4bbe-a339-92a9e75146d0","name":"422 Unprocessable Entity","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//cancelReasons"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"5b1a284f-12a1-4ec0-9f90-5de5fb5fb09a","name":"500 Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://rest.fadv.com/api/v1.1/accounts//cancelReasons"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"bc836eeb-f260-4b3f-a2fa-585a3c6b41e8"}],"id":"bc6f6fba-5b86-4eb9-b095-fa23b2501901","description":"Actions Supported:
\nCreating new user, activate/disable the user, change password for usage of First Advantage background services.\nAction Supported:
\nCreate/Update/Activate/Deactivate a User
\nHeaders
\n Authorization: \nAttributes (User)
\nBody
\n {\n \"account\" : \"250250SFA\",\n \"user_id\" : \"John.Doe\",\n \"active\" : \"true\",\n \"first_name\" : \"John\",\n \"middle_name\" : \"Doe\",\n \"last_name\" : \"Doe\",\n \"email\": \"John.doe@fadv.com\",\n \"profile\":\"RECPROFILE\",\n \"phone\":\"122-330-75512\"\n }\nBody
\n {\n \"code\": \"401\",\n \"message\": \"test\",\n \"occurred_at\": \"Thu Apr 19 09:32:28 GMT 2018\",\n \"cause\": \"test\",\n \"recommendation\": \"review\"\n }\nfirst_name (string, required) - The first name of the user.last_name (string, required) - The last name of the user.user_id (string, required) - The user id used for signup.email (string, required) - The email used for signup. Should default to invite email.phone (string, required) - The phone number of the user.account (string, required) - First Advantage assigned customer account id.middle_name (string, optional) - The middle name of the user.active (string, optional) - To activate or deactivate the user.password (string, optional) newpassword (string, optional) root_account (string, optional) - First Advantage assigned root account id.profile (string, optional) - First Advantage Profile id.sso_client_name (string, optional) - SSO client name.sso_client_user (string, optional) - SSO client user.client_ip (string, optional) - The IP Address during registration for audit purposes.registration_date (string, optional) - The registration creation timestamp. Ignored during creation.roles (array[string], optional)status (string, optional)Creating new user, activate/disable the user, change password for usage of First Advantage background services.\nAction Supported:
\nChange password for a user
\nHeaders
\n Authorization: \nAttributes (UserChangePassword)
\nBody
\n {\n \"account\" : \"test account\",\n \"user_id\" : \"John.Doe\",\n \"password\" : \"\",\n \"newpassword\" : \"new test\"\n }\nBody
\n {\n \"code\": \"400\",\n \"message\": \"test\",\n \"occurred_at\": \"Thu Apr 19 09:32:28 GMT 2018\",\n \"cause\": \"test\",\n \"recommendation\": \"review\"\n }\naccount (string, required) - First Advantage assigned customer account id.user_id (string, required) - The user id used for signup.password (string, required) newpassword (string, required)status (string, optional)Ability to create, update, and deactivate users.
\nActions Supported:
\nA sample Workflow may involve:\n![\"API](\"https://rest.fadv.com/docs/images/user-update.png\")
Documented values: client_credentials or refresh_token
\n"}],"url":"https://rest.fadv.com/api/v1.1/oauth2/token","description":"Headers:
\ngrant_type:client_credentials
\nAuthorization: Basic <Base 64 encoded client_id:client_secret>
\nNote: For access_token
\ntoken_type: \"Bearer\"
\nexpires_in has a value 86400s = 1 day
\nHeaders
\n Authorization: Basic \n grant_type: client_credentials or refresh_token\n refresh_token: Optional header\nAttributes (Oauth2 Token response)
\nBody
\n {\n \"token_type\":\"Bearer\",\n \"access_token\":\"\",\n \"expires_in\":3888000,\n \"refresh_token\":\"\"\n }\nError code for bad request.
\n+ Body\n\n {\n \"code\": \"400\",\n \"message\": \"custom message\",\n \"occurred_at\": \"Fri Oct 25 09:49:00 GMT 2018\",\n \"cause\": \"Bad Request\",\n \"recommendation\": \"Review\"\n }\nError code for Unauthorized.
\nError code for Method Not Allowed.
\nNo additional error description is provided.
\ntoken_type (string, required) access_token (string, required) expires_in (number, required) refresh_token (string, required)FADV will share ClientID and Client Secret with the Customer. It’s critical that the customer keep client secret safe. \nSome Notes -
\nEndpoint to monitor candidate enrollment.
\nCandidate must have below data for successful enrollment:
\nHeaders
\n Authorization: \nAttributes (monitor)
\nBody
\n { \n \"candidate_id\":\"f-dfgdf-02682d572aad\",\n \"product_type\":\"CRIMINAL\",\n \"group_name\":\"TEST_GROUP\",\n \"notification_url\" : \"test\",\n \"reference_id\":\"BOS\",\n \"additional_attributes\":{ \n \"order_as\":{ \n \"user_id\":\"REST\",\n \"account_id\":\"xxxx\",\n \"email\":\"abc@testmail.com\"\n }\n },\n \"quote_backs\":[ \n { \n \"name\":\"test\",\n \"value\":\"c05avsdvsd9258-02682d8fa4f5\"\n }\n ],\n \"client_references\": [\" e12d4sdfsd02682d6c6832 \", \"crtest2\"]\n }\nAttributes (Monitor Enroll response)
\nBody
\n {\n \"enrollment_id\":\"E-123XXXX\"\n }\nError code for bad request.
\n+ Attributes (ResponseError1)\n\n\n+ Body\n\n {\n \"code\": \"400\",\n \"message\": \"custom message\",\n \"occurred_at\": \"Wed Nov 28 09:17:25 GMT 2018\",\n \"cause\": \"custom message\",\n \"recommendation\": \"Review\"\n }\nAttributes (ResponseError1)
\nBody
\n {\n \"code\": \"401\",\n \"message\": \"custom message\",\n \"occurred_at\": \"Wed Nov 28 09:17:25 GMT 2018\",\n \"cause\": \"custom message\",\n \"recommendation\": \"Review\"\n }\nAttributes (ResponseError1)
\nBody
\n {\n \"code\": \"404\",\n \"message\": \"Candidate not found.\",\n \"occurred_at\": \"Wed Nov 28 09:22:29 GMT 2018\",\n \"cause\": \"Bad Request\",\n \"recommendation\": \"Review\"\n }\nAttributes (ResponseError1)
\nBody
\n {\n \"code\": \"409\",\n \"message\": \"FAILURE\",\n \"occurred_at\": \"Thu Jun 06 09:37:30 UTC 2019\",\n \"cause\": \"Error : Subject already enrolled.\",\n \"enrollment_id\": \"00000\",\n \"recommendation\": \"Review\"\n }\nAttributes (ResponseError1)
\nBody
\n {\n \"code\": \"500\",\n \"message\": \"custom message\",\n \"occurred_at\": \"Wed Nov 28 09:17:25 GMT 2018\",\n \"cause\": \"custom message\",\n \"recommendation\": \"Report\"\n }\ncandidate_id (string, required) - Candidate Id for monitoringproduct_type (string, required) - Product type for monitoring - types can be CRIMINAL, HEALTHCARE, and MVRgroup_name (string, required) - Group name for monitoringnotification_url (string, optional) - Webhook URL for status notificationsreference_id (string, optional) - reference id for monitoringquote_backs (array[quoteback], optional) - quoteback reference for clientsadditional_attributes (additionalattributes, optional) - Requestor Detailclient_references (array[string], optional)quoteback reference for clients.
\nname (string, optional) - quoteback namevalue (string, optional) - quoteback valueRequestor Detail
\norder_as (orderas, optional) - Ordering Account detailsaccount_id (string) - Requested account Iduser_id (string) - Requested user Idemail (string) - Requested email Idenrollment_id (string, required)code (string, required) message (string, required) occurred_at (string, required) cause (string, required) recommendation (string, required)Endpoint to monitor candidate disenrollment
\nHeaders
\n Authorization: \nAttributes (Monitor Disenroll response)
\nBody
\n {\n \"status\":\"success\",\n \"message\":\"Dis-Enrollment request successfully placed for the subject : 17XXXX\"\n }\nError code for bad request.
\n+ Attributes (ResponseError1)\n\n\n+ Body\n\n {\n \"code\": \"400\",\n \"message\": \"custom message\",\n \"occurred_at\": \"Wed Nov 28 09:17:25 GMT 2018\",\n \"cause\": \"custom message\",\n \"recommendation\": \"Review\"\n }\nAttributes (ResponseError1)
\nBody
\n {\n \"code\": \"500\",\n \"message\": \"custom message\",\n \"occurred_at\": \"Wed Nov 28 09:17:25 GMT 2018\",\n \"cause\": \"custom message\",\n \"recommendation\": \"Report\"\n }\nstatus (string, required)message (string, required)code (string, required) message (string, required) occurred_at (string, required) cause (string, required) recommendation (string, required)id (string, required)
\naccount (string, required)
\nHeaders
\n Authorization: \nOptional For clients with multiple Accounts – viewAccount and viewUser can be used to specify the Account
\nid (string, required)
\naccount (string, required)
\nuser (string, required)
\nHeaders
\n Authorization: \nFetches list of all the products available for monitoring
\nHeaders
\n Authorization: \nAttributes (string)
\nBody
\n [\n {\n \"product_type\": \"HEALTHCARE_COMPLETE\",\n \"description\": \"Monitored HEAL Complete Search\",\n \"component_type\": \"PRIMXXX\"\n },\n .\n .\n .\n ]\nNote: The source response example is incomplete or invalid JSON and is shown as documented.
\nAttributes (ResponseError1)
\nBody
\n {\n \"code\": \"404\",\n \"message\": \"Resource not found.\",\n \"occurred_at\": \"Tue Dec 11 12:10:14 GMT 2018\",\n \"cause\": \"Bad Request\",\n \"recommendation\": \"Review\"\n }\nAttributes (ResponseError1)
\nBody
\n {\n \"code\": \"500\",\n \"message\": \"custom message\",\n \"occurred_at\": \"Wed Nov 28 09:17:25 GMT 2018\",\n \"cause\": \"custom message\",\n \"recommendation\": \"Report\"\n }\ncode (string, required) message (string, required) occurred_at (string, required) cause (string, required) recommendation (string, required)Monitor API enables enrollment/disenrollment to Products like Criminal, HealthCare, Licenses\n![\"API](\"https://rest.fadv.com/docs/images/enroll_disenroll.png\")
Note: For Disenrollment just like Monitoring Step 2 – Client just has to call Monitoring API with disenroll action and enrollment_id.
\n","_postman_id":"5e3a4e59-3a86-4354-8687-0c393a74b8dd"},{"name":"Required Fields","item":[],"id":"066f970d-7c57-4e5b-b970-a71ac472beaa","description":"","_postman_id":"066f970d-7c57-4e5b-b970-a71ac472beaa"},{"name":"Error Messages","item":[],"id":"7f349f58-4ec8-4032-b116-acd5fb48feb1","description":"","_postman_id":"7f349f58-4ec8-4032-b116-acd5fb48feb1"},{"name":"Status Page","item":[],"id":"45bce6cb-b7fa-49b0-a5cf-35cd13fc0e76","description":"+ Body\n \n {\n \"order\": {\n \"order_id\": \"\",\n \"order_status\": \"\",\n \"result_status\": \"\",\n \"score\": \"\",\n \"result_url\": \"\",\n \"application_details\": {\n \"applicant_id\": \"KIJBFF5ASK\",\n \"application_status\": \"Started\",\n \"application_event\": \"Applicant Invitation Email Resent\",\n \"application_url\": \"https://enterprisetest.fadv.com/pub/l/candidatedatacapture/CD2S7YCKWH54CSFRW7MFH7CVRVDABCDE\",\n \"is_rescreen\": \"false\"\n },\n \"personal_data\": {\n \"person_name\": {\n \"middle_name\": \"\",\n \"given_name\": \"George\",\n \"family_name\": \"Brown\",\n \"type\": \"subject\"\n },\n \"identities\": {\n \"government_ids\": [\n {\n \"number\": \"501-51-1111\",\n \"country\": \"US\",\n \"type\": \"SSN\"\n }\n ]\n },\n \"date_of_birth\": \"1981-02-01\"\n },\n \"meta_data\": {\n \"client_references\": [\n \"ApplicantId_97\",\n \"RequsitionId_162\"\n ],\n \"user_defined_fields\": [\n \"FIN-DIR\",\n \"Alliances (ALNCE)\",\n \"GCS Asia, Pacific & Japan (GCS_APJ)\",\n \"San Francisco, USA (US_SF)\",\n \"USD\"\n ],\n \"quote_backs\": [\n {\n \"name\": \"ApplicantId\",\n \"value\": \"KIJBFF5ASK\"\n },\n {\n \"name\": \"order_account\",\n \"value\": \"240230FAD\"\n },\n {\n \"name\": \"test-2\",\n \"value\": \"value-2\"\n },\n {\n \"name\": \"source\",\n \"value\": \"REST-API\"\n },\n {\n \"name\": \"cdc_notification_url\",\n \"value\": \"cdcurl\"\n },\n {\n \"name\": \"notification_url\",\n \"value\": \"test url\"\n },\n {\n \"name\": \"test-1\",\n \"value\": \"value-1\"\n },\n {\n \"name\": \"candidate_id\",\n \"value\": \"908dcb40-a0e3-11ba-9f70-c2032919a8b5\"\n }\n ]\n }\n }\n }\n \nEndpoint to get order status-
\nGET: https://{hostname}/api/v1/orders/{Order-ID}/status/details/viewAccount/{Account-ID}/viewUser/{UserID}
\n+ Body\n\n {\n \"order\": {\n \"order_id\": \"WPS-6990000\",\n \"order_status\": \"Completed\",\n \"result_status\": \"Pass\",\n \"score\": \"Eligible\",\n \"result_url\": \"https://enterprisetest.fadv.com?key=\",\n \"screenings\": [\n {\n \"type\": \"PRINCRP\",\n \"sub_type\": \"NCRP\",\n \"order_status\": \"Completed\",\n \"result_status\": \"Pass\"\n },\n {\n \"type\": \"SSNV\",\n \"order_status\": \"Completed\",\n \"result_status\": \"Pass\"\n }\n ],\n \"meta_data\": {\n \"quote_backs\": [\n {\n \"name\": \"id\",\n \"value\": \"123d0050-322a-11e9-bd89-02682123400000\"\n },\n {\n \"name\": \"notification_url\",\n \"value\": \"http://cxch1:8080/pub/xchange/testClient1\"\n },\n {\n \"name\": \"candidate_id\",\n \"value\": \"797f8900-3229-11e9-b97d-yyy02682xxxx\"\n },\n {\n \"name\": \"source\",\n \"value\": \"REST-API\"\n },\n {\n \"name\": \"guiID\",\n \"value\": \"uuidabcd-1234\"\n }\n ]\n },\n \"additional_items\": [\n {\n \"type\": \"Ordered_Date\",\n \"value\": \"2020-06-04\"\n },\n {\n \"type\": \"Completion_Date\",\n \"value\": \"2020-06-06\"\n },\n {\n \"type\": \"Expected_Completion_Date\",\n \"value\": \"2020-06-09\"\n }\n ]\n }\n }\n \n+ Body\n \n \"order\":\n {\n \"order_id\": \"WPS-1001000\",\n \"order_status\": \"Completed\",\n \"result_status\": \"Pass\",\n \"score\": \"Eligible\",\n \"result_url\": \"https://enterprisetest...\",\n }\n \nMonitoring API - Versions v1.1, v1.2
\nMinor Changes – stability and performance improvements
\nFADV CCR 7340
\nOrder API - Versions v1.1
\nAdded Case Ordered and Case Modified dates in Order Status
\nFADV CCR 7280
\nCandidate API - Versions v1.1, v1.2
\nMonitoring API - Versions v1.1, v1.2
\nNew endpoint for enrolment information lookup based on quoteback id and values
\nFADV CCR 7184
\nInvite API - Versions v1.1
\nCandidate API - Versions v1.1, v1.2
\nCandidate_id added to 409 error message during Candidate Data Update (PUT operation)
\nFADV CCR 6881
\ncode (string, optional) message (string, optional)Order data object
\ncandidate_id (string, required) - Candidate Id for creating orderpackage_id (string) - Package Id to create orderemployment_start_date (string, optional) - The employment start date for the applicant.account_id (string, optional) - Account Id to create ordertwo_step: false (boolean, optional) - flag to create 1-step or 2-step ordernotification_url (string, optional) - Webhook URL for status notificationsclient_references (array[string], optional) user_defined_fields (array[string], optional) quote_backs (array[quotebackasType], optional) additional_attributes (additionalattributesasType, optional) - Requestor Detaillocale (locale, optional) - Locale informationposition_applied_for (string, optional) - name of the position to applyposition_locations (array[positionlocationasType], optional) add_ons (array[addonsasType], optional)quoteback reference for clients.
\nname (string, optional) - quoteback namevalue (string, optional) - quoteback valueRequestor Detail
\norder_as (orderas, optional) - Ordering Account detailssystem: EA (string, optional) - System where order is to be createdaccount_id (string) - Requested account Iduser_id (string) - Requested user Idemail (string) - Requested email Idlanguage_code (string, optional) - Language codecountry_code (string, optional) - Country codeDetails of the position
\ncity (string, optional) - Position in the citystate (string, optional) - Position in the statecountry (string, optional) - Position in the countryadd-on indicator for screening components
\ntype (string, optional) - type code for screening componentAdjudicate data object
\nscore (string, required) - scorescore_status (string, optional) - score statusadditional_attributes (additionalattributesasType, optional) - Requestor Detailcode (string, optional) message (string, optional)##AccountDetailsResponse (object)
\ndetails (array[AccountDetailsType], required)Account details
\naccount_id (string, required) - Account idname (string, required) - Account namefirst_name (string, required) - The first name of the user.last_name (string, required) - The last name of the user.user_id (string, required) - The user id .active (string, optional) - To activate status of the user.account (string, optional) - First Advantage assigned root account id.profile (string, optional) - First Advantage Profile id.sso_client_name (string, optional) - SSO client name.sso_client_user (string, optional) - SSO client user.package_details (array[PackageType], required)Package object schema
\nstatus (string, required) - Status of package details requestaccount (string, optional) - Account id for the package details requestpackageid (string, required) - Package id of the requestname (string, optional) - Name of the packageprice (string, optional) components (ComponentType, required) - List of components assigned to packagepreferences (PreferenceType, required) - Prefences assigned to packageerror (ErrorType, optional) - Error available any error with requestComponent object attributes
\ntype (string, required) - Name of the componentsubtype (string, optional) - Subtype of the componentsearchtype (string, optional) name (string, required) - Name of the componentscope (string, required) - Scope of the sub componentpreferences (PreferenceType, required) - Prefences assigned to packagePreference of the Package
\nid (string, optional) - Preference id mapped in the database.name (string, optional) - Preference namevalue (string, optional) - value assigned to preferenceError attributes
\ncode (string, required) - Error codedescription (string, required) - Error descriptionfirst_name (string, required) - The first name of the user.last_name (string, required) - The last name of the user.email (string, required) - The email used for signup. Should default to invite email.password (string, required) phone (string, required) - The phone number of the user.account (string, optional) - First Advantage assigned customer account id.organization (string, required) - Organization name.client_ip (string, optional) - The IP Address during registration for audit purposes.registration_date (string, optional) - The registration creation timestamp. Ignored during creation.Order status response.
\norder (statusorderidresponse, required) - Order Status.Order status response.
\norder_id (string, required) - First Advantage assigned ID (Case ID) for the applicant's background search order for successful requests.order_status (string, optional) - Case level status. Values are Completed, Preliminary, InProgress, Hold, Cancelled, Disabled, UnderConstruction, Pending and UnexpectedStatus.result_status (string, optional) - Overall results for a completed case. Background Investigation Values[Pass, Fail, Review and UnexpectedResult]. Drug Test Values[ Positive, Unverified, PassWithRestrictions, Scheduled, Rescheduled, NoShow, Collected, PartiallyComplete, NegativeDilute, Negative, UnexpectedResult, HoldMRO, Cancel, RuleViolation].score (string, optional) - Score value for scored cases only. This is sent only at Case Level. Values[ Eligible, Ineligible, RetainInPlace, Cancelled, Decisional, UnexpectedScore, Supplemented].url (string, optional) - Link to the Enterprise Advantage website to view the order status and results. This link will require login authentication.screenings (array[screening], optional) - Contains the details of each screening for this casemeta_data (metadatatype, optional)Order status response
\norder (statusdetailsorderidresponse, required) - Order detailed status.Order status response
\norder_id (string, required) - First Advantage assigned ID (Case ID) for the applicant's background search order for successful requests.screening_status (screeningstatus, required) - Case level status.screenings (array[screening], optional) - Contains the details of each screening for this casescreening_ results_url (string, optional) - Link to the Enterprise Advantage website to view the order status and results.meta_data (metadatatype, optional)order_status (string, optional) - Case level status.score (string, optional) - Score value for scored cases only. This is sent only at Case Level.result_status (string, optional) - Overall results for a completed case.order_status (string, optional) - This is element level status. Screening status.sub_type (string, optional) - Component subtype value.description (string, optional) - Description of screening type.result_status (string, optional) - Screening result for completed screenings.type (string, optional) - Component type value.password (string, required)id (string, optional) username (string, optional) access_token (string, optional) refresh_token (string, optional) roles (array[string], optional) session_timeout (number, optional) attributes (string, optional)name (string, required) value (string, required)Meta data submitted with order
\nclient_references (array[string], optional) user_defined_fields (array[string], optional) quote_backs (array[quotebacktype], optional)candidate_id (string, required) - candidate_id from Candidate APIpackage_id (string, required) - The specific search package being requested in the order once the candidate submits the application.employment_start_date (string, optional) - The employment start date for the applicant.position_applied_for (string, optional) - name of the position to applyposition_locations (array[positionlocationasType], optional)notification_url (string, optional) - webhook URL for status notificationsclient_references (array[string], optional) user_defined_fields (array[string], optional)quote_backs (array[quotebacktype], optional) locale (localetype, optional) - Locale consists of at least a language identifier and a region identifier.additional_attributes (additionalattributesasType, optional) - Additional attributescandidate_type (string, optional) - Candidate type. Value is case-sensitive.documents (array[documentitemtype], optional) - array of document id's available for a candidatelanguage_code (string, optional) country_code (string, optional)document id reference for invite
\ndocument_id (string, required) - document id for referencetype (string, required) - doc type of a document. Eg.- mention type value as 2 for Authorization and 144 for Resumeapplicant_id (object, required) - Unique id for each candidate.order_id (object, optional) - Unique id for each order.applicant_id (object, optional) - Unique id for each candidate.status (string, optional) event (string, optional) is_rescreen (string, optional) link (string, optional) link_expiration_date (string, optional) meta_data (metadatatype, optional)filename (string, required)name (string, required) description (string, required) id (string, required) type (string, required)filename (string, required)name (string, required) description (string, required) id (string, required) type (string, required)order_status_webhook_url (string, optional) - Webhook(Notification URL) to push order status.candidate_invite_status_webhook_url (string, optional) - Webhook(Notification URL) push candidate invite status.user_name (string, optional) - Username for basic authenticationpassword (string, optional) - Password for basic authenticationheaders (array[headerfield], optional)Custom header field information needed for client
\nkey (string, optional) - Custom header namevalue (string, optional) - Custom header valuemunicipality (array[MunicipalityType], required) region (string, required) postal_code (string, required) country_code (string, required) delivery_address (DeliveryAddress, optional)contact_method (ContactMethod, required)given_name (string, optional) middle_name (string, optional) family_name (string, optional) maiden_name (string, optional) suffix (string, optional) father_name (string, optional) mother_name (string, optional) mother_maiden_name (string, optional) local_lang_name (string, optional) salutation (string, optional) has_middle_name (string, optional) type (string, optional)given_name (string, required) family_name (string, required) type (enum, required) - Specifies the type in case of candidate having multiple names. Person with type subject is required.subjectmaidenEnum_aliasothermiddle_name (string, optional) maiden_name (string, optional) suffix (string, optional) father_name (string, optional) mother_name (string, optional) mother_maiden_name (string, optional) local_lang_name (string, optional) salutation (string, optional) has_middle_name (string, optional)type (enum[string], required) - The type of Id.SSNPASSPORTGOVTSINSNBMONITORING-DLnumber (string, required) - Id number.country (string, required) - Id issued country.issue_date (string, optional) - Id issue date. suggested format: yyyy-MM-ddexpiry_date (string, optional) - Id expiry date. suggested format: yyyy-MM-dddescription (string, optional) - Details about the Id typecountry_code (string, required) region (string, required) municipality (array[MunicipalityType], required) postal_code (string, optional) delivery_address (DeliveryAddress, optional) start_at (string, optional) - suggested format: yyyy-MM-ddend_at (string, optional) - suggested format: yyyy-MM-ddtype (enum[string], optional) - Specifies the address typecurrentpriorhukoubirthtype (enum[string], optional) CITYCOUNTYOTHERvalue (string, optional)first_name (string, required) - The first name of the user.last_name (string, required) - The last name of the user.user_id (string, required) - The user id used for signup.email (string, required) - The email used for signup. Should default to invite email.phone (string, required) - The phone number of the user.account (string, required) - First Advantage assigned customer account id.middle_name (string, optional) - The middle name of the user.active (string, optional) - To activate or deactivate the user.password (string, optional) newpassword (string, optional) root_account (string, optional) - First Advantage assigned root account id.profile (string, optional) - First Advantage Profile id.sso_client_name (string, optional) - SSO client name.sso_client_user (string, optional) - SSO client user.client_ip (string, optional) - The IP Address during registration for audit purposes.registration_date (string, optional) - The registration creation timestamp. Ignored during creation.roles (array[string], optional)account (string, required) - First Advantage assigned customer account id.user_id (string, required) - The user id used for signup.password (string, required) newpassword (string, required)status (string, optional)error (object, optional)documentid: 0xxx7c00-xxxx-00e9-xxxx-0200ac110004 (string, required) success: true (string, required)fileName: testFile.txt (string, required) fileSize: 24 (string, required) uploaded_at: Mon Aug 27 06:50:12 GMT 2018 (string, required) documentType: Resume (string, required) documentTypeId: some value (string, required) documentId: 560668 (string, required) fileContentType: text/plain (string, required)token_type (string, required) access_token (string, required) expires_in (number, required) refresh_token (string, required)candidate_id (string, required) - Candidate Id for monitoringproduct_type (string, required) - Product type for monitoring - types can be CRIMINAL, HEALTHCARE, and MVRgroup_name (string, required) - Group name for monitoringnotification_url (string, optional) - Webhook URL for status notificationsreference_id (string, optional) - reference id for monitoringquote_backs (array[quoteback], optional) - quoteback reference for clientsadditional_attributes (additionalattributes, optional) - Requestor Detailclient_references (array[string], optional)Requestor Detail
\norder_as (orderas, optional) - Ordering Account detailsquoteback reference for clients.
\nname (string, optional) - quoteback namevalue (string, optional) - quoteback valuestatus (string, required)message (string, required)enrollment_id (string, required)code (string, required) message (string, required) occurred_at (string, required) cause (string, required) recommendation (string, required)candidate_id (string, required) - Profile Advantage candidate profile id.package_id (string, required) - The specific search package being requested in the order once the candidate submits the application.employment_start_date (string, optional) - The employment start date for the applicant.position_applied_for (string, optional) - name of the position to applyposition_locations (array[positionlocationasType], optional)notification_url (string, optional) - webhook URL for status notificationsclient_references (array[string], optional) user_defined_fields (array[string], optional)quote_backs (array[quotebacktype], optional) locale (localetype, optional) - Locale consists of at least a language identifier and a region identifier.additional_attributes (additionalattributesasType, optional) - Additional attributescandidate_type (string, optional) - Candidate type. Value is case-sensitive.documents (array[documentitemtype], optional) - array of document id's available for a candidatecopy_to_applicant (string, optional) - Applicant may request to receive a detailed results reportnew_package_info (newpackageinfo, optional) - details for new package to be createddetails for new package to be created
\npackage_settings (packagesettingstype, optional) - settings for the packagecomponents (array[componenttype], optional) - list of componentspackage settings
\ntemplate_id (string, optional) - template idadjudication (string, optional) - adjudication consent Y or Npri_type (string, optional) - pri typepri_max_elements (string, optional) - pri max elementsedu_type (string, optional) - education typeedu_max_elements (string, optional) - max no of elementsemp_type (string, optional) - employment typeemp_max_elements (string, optional) - max no of elementsreferences_max_elements (string, optional) - max no of elementsoptions for the scope
\nscope_yrs (string, optional) - xchange typeDetails of the new component to be created
\ncomponent_name (string, optional) - name of the componenttype (string, required) - component typesub-type (string, optional) - component sub typecomponent_settings (componentsettingstype, optional) - settings for the componentfile (string, required) - the file to uploadcode (string, optional) message (string, optional) occurred_at (string, optional) cause (string, optional) recommendation (string, optional)id (string, optional) - The internal generated id for the candidate's.override_candidate_data (enum[string], optional) - Flag to replace candidate data. true - will update if candidate already exists.true - will update the candidate if candidate already exists else will create a new one. false - will throw a 409 error if candidate already exists else will create a new one.persons (array[Person], required) - A collection of person name details.email (string, optional) - The candidate's preferred contact email.phones (array[Phone], optional) - A collection of candidate's phone numbers.dob (string, optional) - The candidate's Date of birth. date format: yyyy-MM-ddgender (enum[string], optional) - The candidate's gender.malefemaleotherunspecifiedidentities (Identities, optional) addresses (array[Address], optional) - A collection of candidate's addresses.employers (array[Employer], optional) - A collection of employer's details.education (array[Education], optional) - A collection of education details.references (array[Reference], optional) - A collection of references details.criminal_history (array[criminalhistorydata], optional) - A collection of candidate's criminal recordsstreet_address (string, optional) - The delivery address line 1.street_address2 (string, optional) - The delivery address line 2.city (string, optional) - The city or area of the given address.state (string, optional) - The state or region of the candidate. For United States, a 2 letter code is acceptable. e.g UScountry (string, optional) - The country of residence of the address.zip_code (string, optional) - The zip or postal code of the address.start_at (string, optional) - The date of start of residence. date format: yyyy-MM-dd where dd is optionalend_at (string, optional) - The date of end of residence. When absent or set to null indicates current residence. date format: yyyy-MM-dd where dd is optionalis_permanent (string, optional) - specify value as Yes or No if it is a permanent address.candidate_id (string, required)message (string, required)interval_type (string, optional) currency (string, optional) value (string, optional) when (string, optional)person_name (string, optional) internet_email_address (string, optional) website (string, optional) contact_method (ContactMethod, required)telephone (array[Telephone], optional) internet_email_address (string, optional) postal_address (EmployerAddress, optional)location (string, optional) start_date (string, optional) - suggested format: yyyy-MM-ddend_date (string, optional) - suggested format: yyyy-MM-ddlocation (string, optional) start_at (string, optional) - suggested format: yyyy-MM-ddend_at (string, optional) - suggested format: yyyy-MM-dddegree_major (DegreeMajor, optional) degree_measure (DegreeMeasure, optional) degree_date (string, optional) - suggested format: yyyy-MM-dddegree_minor (string, optional) honors (string, optional) other_honors (string, optional) degree_type (string, optional)name (array[string], optional)educational_measure (EducationalMeasure, optional)address_line (array[string], optional)provider_ref_id (string, optional) - custom reference id to be used by the clientschool_name (string, required) local_lang_school_name (string, optional) school_location (string, optional) location_summary (EmployerAddress, optional) contact_info (ContactInfo, optional) degree (Degree, optional) dates_of_attendance (DatesOfAttendance, optional) person_name (Person, optional) school_type (string, optional) use_for_add_ons (enum[string], optional) - optional add-on indicator for screening section. values allowed true or false.truefalsemeasure_system (string, optional) measure_value (MeasureValue, optional) highest_possible_value (string, optional)provider_ref_id (string, optional) - custom reference id to be used by the clientemployer_name (string, required) local_lang_employer_name (string, optional) employee_id (string, optional) employer_address (EmployerAddress, optional) title (string, optional) department (string, optional) dates_of_employment (array[DatesOfEmployment], optional) compensation (array[Compensation], optional) contact_info (ContactInfo, optional) supervisor (Supervisor, optional) reason_for_leaving (string, optional) permission_to_contact (enum[string], optional) - values allowed true or false.truefalsebusiness_type (string, optional) ptc_override_flag (enum[string], optional) - values allowed true or false.truefalsejob_type (string, optional) contact_date (string, optional) - date format: yyyy-MM-dd where dd is optionalagency (string, optional) duties (string, optional) type (string, optional) use_for_add_ons (enum[string], optional) - optional add-on indicator for screening section. values allowed true or false.truefalsecountry_code (string, optional) postal_code (string, optional) region (string, optional) municipality (array[Municipality], optional) delivery_address (DeliveryAddress, optional) start_at (string, optional) - suggested format: yyyy-MM-ddend_at (string, optional) - suggested format: yyyy-MM-ddtype (enum[string], optional) - Specifies the address typecurrentpriorhukoubirthhasSSN (string, optional) - Y or N to indicate SSN information provided or not.hasUAN (string, optional) - Y or N to indicate UAN information provided or not.ids (array[Id], optional) - Government IDs like SSN, Passport and other country specific.type (enum[string], optional) - The type of Id.SSNPASSPORTGOVTSINSNBMONITORING-DLUANnumber (string, optional) - Id number.country (string, optional) - Id issued country.issue_date (string, optional) - Id issue date. suggested format: yyyy-MM-ddexpiry_date (string, optional) - Id expiry date. suggested format: yyyy-MM-ddid_type_code (enum[string], optional) - The type of Identity code.LASTAAD - can be used for Aadhaar cardPERMACTNBdescription (string, optional) - Details about the Id typelicenses (array[License], optional) - A list of licenses available.government_ids (GovernmentIds, optional)provider_ref_id (string, optional) - custom reference id to be used by the clientlicense_name (enum[string], optional) - The type of license.cerfaaindlicmvrinsDRIVER_LICENSE_IDPASSPORTGOVTNPI_IDHDEAHLICHSCSHORCtype (enum[string], optional) - The type of license.CommercialNon-CommercialNurseAideHealthcareProviderPERMANENTTEMPORARYGUESTOTHERN/Anumber (string, optional) - The license number.state (string, optional) - The license issue state. For United States, a 2 letter code is acceptable.country: US (string, optional) - The license issue country.use_for_add_ons (enum[string], optional) - optional add-on indicator for screening section. Values allowed true or false.truelicense_agency (string, optional) - Agency name that issued the license.candidate_name (string, optional) - Name of the Candidate on the license. By default, family name of given Candidate gets mappedlicense_description (string, optional) - Description about the license.numeric_value (string, optional)type (enum[string], optional) CITYCOUNTRYOTHERvalue (string, optional)given_name (string, required) middle_name (string, optional) family_name (string, required) maiden_name (string, optional) suffix (string, optional) father_name (string, optional) mother_name (string, optional) mother_maiden_name (string, optional) local_lang_name (string, optional) salutation (string, optional) has_middle_name (string, optional) type (enum[string], required) - Specifies the type in case of candidate having multiple names. Person with type subject is required.subjectmaidenaliasothercountry_code (string, optional) - Specifies country code. Default is +1extension (string, optional) - Specifies extensionnumber (string, required) - Specifies 10 digit phone numbertype (enum[string], optional) - Specifies the priority of phone number. Default should be kept as primaryprimaryalternateprovider_ref_id (string, optional) - custom reference id to be used by the clientperson_name (Person, optional) reference_type (string, optional) postal_address (EmployerAddress, optional) years_acquainted (string, optional) contact_info (ContactInfo, optional)supervisor_name (string, optional) supervisor_title (string, optional) supervisor_contact_info (SupervisorContactInfo, optional)person_name (string, optional) internet_email_address (string, optional) contact_method (ContactMethod, optional)number (string, optional) extension (string, optional) type (string, optional)filename (string, required) elements (array[string], optional)name (string, required) description (string, required) id (string, required) type (string, required)filename (string, required) elements (array[string], optional)name (string, required) description (string, required) id (string, required) type (string, required)provider_ref_id (string, optional) - custom reference id to be used by the clientcharge_or_complaint (string, optional) - Criminal charge or complaint - example: ASSAULTcharge_type_classification (enum[string], optional) - The type of the criminal charge.felonyforfeitureinfractionmisdemeanorpettyOffencesummarytrafficviolationcapiasshowCauseordinanceViolationsealedfelonyReducedToMisdemeanormisdemeanorReducedToViolationunknowncharge_description (string, optional) - Details of the charges.charge_date (string, optional) - Charge date. suggested format: yyyy-MM-dd or yyyy-MM or yyyycharge_address (simpleaddress, optional) offense_date (string, optional) - Offense date. suggested format: yyyy-MM-dd or yyyy-MM or yyyyarrest_date (string, optional) - Arrest date. suggested format: yyyy-MM-dd or yyyy-MM or yyyydisposition_date (string, optional) - Disposition date. suggested format: yyyy-MM-dd or yyyy-MM or yyyydisposition (string, optional) - Details of the disposition.region (string, optional) municipality (array[MunicipalityType], optional)Cancel order object
\nadditional_attributes (additionalattributes, optional) - Ordering Account detailscancel_order_criteria (cancelordercriteria, optional) - Cancel order detailsCancel order details
\ncancel_reasons (array[string], optional) - Cancel reasons for order cancellationclient_references (array[string], optional) - Client references for order cancellationidentities (identities, optional) - identity data to be used for cancellationpackage_id (string, optional) - package id for the orderadditional_items (array[additionalitems], optional) - array of additional itemscreation_date_time (string, optional) - creation date time for the orderidentity data to be used for cancellation
\ngovernment_ids (governmentids, optional) - identity data to be used for cancellationidentity data to be used for cancellation
\nhasSSN (string, optional) - Y or N value for hasSSNhasUAN (string, optional) - Y or N value for hasUANids (array[ids], optional) - id detailsId details
\ntype (string, optional) - Id typenumber (string, optional) - Id numbercountry (string, optional) - countryadditional items data.
\nname (string, optional) - additional item namevalue (string, optional) - additional item valuestatus (string, required)cancel_reasons (array[string], optional) - Cancel reasons used for order cancellation