openapi: 3.2.0
info:
  contact:
    name: Lavanya Appa
    email: LAVANYA.APPA@ADP.COM
  description: The Applicant Onboarding v2 APIs are used to manage the process of transfering the applicant data into HCM systems, including reading the API metadata.
  title: Applicant Onboarding Onboarding Process Management API
  version: 2.0.1
  x-apievangelist-source: https://api-library-marketplace.adp.com/hcm-offrg-wfn/hcm/applicant-onboarding/v2/applicant-onboarding-swagger_v2-merged.json
  x-apievangelist-product: ADP Workforce Now (hcm-offrg-wfn)
  x-apievangelist-resource-path: hcm/applicant-onboarding/v2/applicant-onboarding
servers:
- url: https://api.adp.com
  description: 'ADP production API gateway (mutual-TLS). Source: https://developers.adp.com/getting-started/key-concepts/access-tokens'
- url: https://api.eu.adp.com
  description: ADP European API gateway
- url: https://uat-api.adp.com
  description: ADP UAT / sandbox gateway
tags:
- name: Onboarding Process Management
  description: APIs to manage the applicant onboarding process
paths:
  /hcm/v2/applicant.onboard:
    x-adpPathData:
      uriTranslationIndicator: false
      featureCode: applicantOnboardingManagement
      functionCode: onboardingProcessManagement
      serviceCode: integrationManagement
      serviceCategoryCode: hcm
      canonicalName: Applicant Onboarding
    post:
      summary: Initiate New Applicant Onboarding
      x-adpOperationData:
        operationStateCode: active
        grantTypes:
        - authorization_code
        - urn:ietf:params:oauth:grant-type:saml2-bearer
        - urn:ietf:params:oauth:grant-type:jwt-bearer
        - client_credential
        asaFeatureCodes:
        - MobileADMApplicantOnboard
        - MobilePSSApplicantOnboard
        sorRequestTimeoutPolicies:
          cachedTimeout: 3
          notCachedTimeout: 10
        canonicalUri: hcm/integrationManagement/applicantOnboardingManagement/onboardingProcessManagement/applicant.onboard
        operationCode: applicant.onboard
        operationId: c2fe03be-a3ba-470a-88fe-ec02b2216905
        performAuthIndicator: true
        roleCodes:
        - administrator
        - practitioner
        scenarios:
        - summary: CA Template - Response when using a custom <strong>templateNameCode</strong> as configured with Personal, Employment, Payroll, Tax steps.
          headers:
            ADP-Context-ExpressionID: country=CA
          name: 08. Starts the applicant onboarding process (Inprogress state) for CA Template - Full Payload with minimal fields populated
          responses:
          - headers:
              Retry-After: ''
              Location: ''
            code: '201'
            description: Applicant record is created
            content:
              application/json:
                externalValue: ./examples/08._Starts_the_applicant_onboarding_process_(Inprogress_state)_for_CA_Template_-_Full_Payload_with_minimal_fields_populated_Custom_Example_applicant.onboard_201_353698.json
          description: CA Template - Response when using a custom <strong>templateNameCode</strong> as configured with Personal, Employment, Payroll, Tax steps.
          content:
            application/json:
              externalValue: ./examples/08._Starts_the_applicant_onboarding_process_(Inprogress_state)_for_CA_Template_-_Full_Payload_with_minimal_fields_populated_Custom_Example_applicant.onboard_request_32328.json
        - summary: <strong>CANADA Clients</strong><span>&nbsp;- Response when using custom&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;with steps Personal, Employment, Payroll, and Tax.</span>
          headers:
            ADP-Context-ExpressionID: country=CA
          name: 02. Starts the applicant onboarding process (Inprogress state) for CANADA Client - Minimal Payload
          responses:
          - headers:
              Retry-After: ''
              Location: ''
            code: '201'
            description: Successful response of applicant onboard process of Inprogress state for CANADA Client.
            content:
              application/json:
                externalValue: ./examples/02._Starts_the_applicant_onboarding_process_(Inprogress_state)_for_CANADA_Client_-_Minimal_Payload_Custom_Example_applicant.onboard_201_44562.json
          description: <strong>CANADA Clients</strong><span>&nbsp;- Response when using custom&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;with steps Personal, Employment, Payroll, and Tax.</span>
          content:
            application/json:
              externalValue: ./examples/02._Starts_the_applicant_onboarding_process_(Inprogress_state)_for_CANADA_Client_-_Minimal_Payload_Custom_Example_applicant.onboard_request_3905.json
        - summary: <div><strong>US Clients</strong><span>&nbsp;- Response when using&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;as Applicant Onboard in the request.</span></div>
          name: 01. Starts the applicant onboarding process (Inprogress state) for US Client - Minimal payload
          responses:
          - headers:
              Retry-After: unset
              Location: unset
            code: '201'
            description: Applicant record is created
            content:
              application/json:
                externalValue: ./examples/01._Starts_the_applicant_onboarding_process_(Inprogress_state)_for_US_Client_-_Minimal_payload_Custom_Example_applicant.onboard_201_616061.json
          description: <div><strong>US Clients</strong><span>&nbsp;- Response when using&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;as Applicant Onboard in the request.</span></div>
          content:
            application/json:
              externalValue: ./examples/01._Starts_the_applicant_onboarding_process_(Inprogress_state)_for_US_Client_-_Minimal_payload_Custom_Example_applicant.onboard_request_59081.json
        - summary: Worked-In County should be Mandatory if the SUI/SDI Tax Code is West Virginia
          name: 21. Hiring an Employee completely for the US client with Worked in County
          responses:
          - headers:
              Retry-After: unset
              Location: unset
            code: '201'
            description: Successful response of applicant onboard process of complete state for US Client when SUI code is Worked in County
            content:
              application/json:
                externalValue: ./examples/21._Hiring_an_Employee_completely_for_the_US_client_with_Worked_in_County_Custom_Example_applicant.onboard_201_497841.json
          description: Worked-In County should be Mandatory if the SUI/SDI Tax Code is West Virginia
          content:
            application/json:
              externalValue: ./examples/21._Hiring_an_Employee_completely_for_the_US_client_with_Worked_in_County_Custom_Example_applicant.onboard_request_47070.json
        - summary: US Clients - Response when using <strong>templateNameCode</strong> as <strong>HR + Payroll (System)</strong> in the request.
          headers:
            ADP-Context-ExpressionID: country=US
          name: 07. Starts the applicant onboarding process (Inprogress state) for US templates -Full Payload with minimal fields populated
          responses:
          - headers:
              Retry-After: ''
              Location: ''
            code: '201'
            description: Applicant record is created
            content:
              application/json:
                externalValue: ./examples/07._Starts_the_applicant_onboarding_process_(Inprogress_state)_for_US_templates_-Full_Payload_with_minimal_fields_populated_Custom_Example_applicant.onboard_201_353695.json
          description: US Clients - Response when using <strong>templateNameCode</strong> as <strong>HR + Payroll (System)</strong> in the request.
          content:
            application/json:
              externalValue: ./examples/07._Starts_the_applicant_onboarding_process_(Inprogress_state)_for_US_templates_-Full_Payload_with_minimal_fields_populated_Custom_Example_applicant.onboard_request_32327.json
        - summary: '<p>Enhanced time inprogress hire</p><p>This is needed to indicate if using time in the hire</p><p>&quot;applicantTimeProfile&quot;: {</p><p>&nbsp; &nbsp; &nbsp; &quot;timeProductCode&quot;: {</p><p>&nbsp; &nbsp; &nbsp; &nbsp; &quot;code&quot;: &quot;ETIME&quot;</p><p>&nbsp; &nbsp; &nbsp; },</p>'
          name: 23. Enhanced time inprogress hire
          responses:
          - headers:
              Retry-After: unset
              Location: unset
            code: '201'
            description: Success response
            content:
              application/json:
                externalValue: ./examples/23._Enhanced_time_inprogress_hire_Custom_Example_applicant.onboard_201_619209.json
          description: '<p>Enhanced time inprogress hire</p><p>This is needed to indicate if using time in the hire</p><p>&quot;applicantTimeProfile&quot;: {</p><p>&nbsp; &nbsp; &nbsp; &quot;timeProductCode&quot;: {</p><p>&nbsp; &nbsp; &nbsp; &nbsp; &quot;code&quot;: &quot;ETIME&quot;</p><p>&nbsp; &nbsp; &nbsp; },</p>'
          content:
            application/json:
              externalValue: ./examples/23._Enhanced_time_inprogress_hire_Custom_Example_applicant.onboard_request_59986.json
        - summary: <span>International Template - using&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;as&nbsp;</span><strong>International (System)</strong><span>&nbsp;in the request.</span>
          headers:
            ADP-Context-ExpressionID: country=INT
          name: 09. Starts the applicant onboarding process (Inprogress state) for International Templates -Full Payload with minimal fields populated
          responses:
          - headers:
              Retry-After: ''
              Location: ''
            code: '201'
            description: Applicant record is created
            content:
              application/json:
                externalValue: ./examples/09._Starts_the_applicant_onboarding_process_(Inprogress_state)_for_International_Templates_-Full_Payload_with_minimal_fields_populated_Custom_Example_applicant.onboard_201_353699.json
          description: <span>International Template - using&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;as&nbsp;</span><strong>International (System)</strong><span>&nbsp;in the request.</span>
          content:
            application/json:
              externalValue: ./examples/09._Starts_the_applicant_onboarding_process_(Inprogress_state)_for_International_Templates_-Full_Payload_with_minimal_fields_populated_Custom_Example_applicant.onboard_request_32329.json
        - summary: <strong>US Clients</strong><span>&nbsp;- Response using&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;as <strong>HR + Payroll (System)</strong> in the request.</span>
          headers:
            ADP-Context-ExpressionID: country=US
          name: 04. Hiring an employee completely for the US Client - Full Payload
          responses:
          - headers:
              Retry-After: ''
              Location: ''
            code: '201'
            description: Successful response of applicant onboard process of Complete state for US Client.
            content:
              application/json:
                externalValue: ./examples/04._Hiring_an_employee_completely_for_the_US_Client_-_Full_Payload_Custom_Example_applicant.onboard_201_44566.json
          description: <strong>US Clients</strong><span>&nbsp;- Response using&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;as <strong>HR + Payroll (System)</strong> in the request.</span>
          content:
            application/json:
              externalValue: ./examples/04._Hiring_an_employee_completely_for_the_US_Client_-_Full_Payload_Custom_Example_applicant.onboard_request_3907.json
        - summary: When first name is not passed in the request payload.
          name: 17. Bad Request - [in progress] - When first name is not passed in the request
          responses:
          - headers:
              Content-Language: unset
              Last-Modified: unset
            code: '400'
            description: 'Response when when expected, start date is not passed in the request.


              Refer the payload values for creating a proper request'
            content:
              application/json:
                externalValue: ./examples/17._Bad_Request_-_[in_progress]_-_When_first_name_is_not_passed_in_the_request_Custom_Example_applicant.onboard_400_495150.json
          - headers:
              Content-Language: unset
              Last-Modified: unset
            code: '400'
            description: 'Response when last name is not passed in the request.


              Refer the payload values for creating a proper request'
            content:
              application/json:
                externalValue: ./examples/17._Bad_Request_-_[in_progress]_-_When_first_name_is_not_passed_in_the_request_Custom_Example_applicant.onboard_400_495149.json
          - headers:
              Content-Language: unset
              Last-Modified: unset
            code: '400'
            description: Response when first name is not passed in the request
            content:
              application/json:
                externalValue: ./examples/17._Bad_Request_-_[in_progress]_-_When_first_name_is_not_passed_in_the_request_Custom_Example_applicant.onboard_400_495148.json
          - headers:
              Content-Language: unset
              Last-Modified: unset
            code: '400'
            description: 'Response when when non-supported template name code is passed in the request.


              Refer the payload values for creating a proper request'
            content:
              application/json:
                externalValue: ./examples/17._Bad_Request_-_[in_progress]_-_When_first_name_is_not_passed_in_the_request_Custom_Example_applicant.onboard_400_495151.json
          description: When first name is not passed in the request payload.
          content:
            application/json:
              externalValue: ./examples/17._Bad_Request_-_[in_progress]_-_When_first_name_is_not_passed_in_the_request_Custom_Example_applicant.onboard_request_46238.json
        - summary: This is an example payload for hiring a TLM employee
          name: 22. TLM Hire inprogress employee
          responses:
          - headers:
              Retry-After: unset
              Location: unset
            code: '201'
            description: Applicant record is created
            content:
              application/json:
                externalValue: ./examples/22._TLM_Hire_inprogress_employee_Custom_Example_applicant.onboard_201_619208.json
          description: This is an example payload for hiring a TLM employee
          content:
            application/json:
              externalValue: ./examples/22._TLM_Hire_inprogress_employee_Custom_Example_applicant.onboard_request_59985.json
        - summary: Starts the applicant onboarding process (Inprogress state) with Ohio(OH) School District for US Client
          name: 11. Starts the applicant onboarding process (Inprogress state) with Ohio(OH) School District for US Client
          responses:
          - headers:
              Retry-After: unset
              Location: unset
            code: '201'
            description: Response of (Inprogress state) with Ohio(OH) School District for US Client
            content:
              application/json:
                externalValue: ./examples/11._Starts_the_applicant_onboarding_process_(Inprogress_state)_with_Ohio(OH)_School_District_for_US_Client_Custom_Example_applicant.onboard_201_479279.json
          description: Starts the applicant onboarding process (Inprogress state) with Ohio(OH) School District for US Client
          content:
            application/json:
              externalValue: ./examples/11._Starts_the_applicant_onboarding_process_(Inprogress_state)_with_Ohio(OH)_School_District_for_US_Client_Custom_Example_applicant.onboard_request_43680.json
        - summary: <p>SOC Code should be mandatory for New Hire Applicant Onboard API if SUI/SDI Tax Codes are below</p><ul><li>Indiana</li><li>Louisiana</li><li>South Carolina</li><li>Washington</li><li>West Virginia</li></ul>
          name: 20. Hiring an employee completely for the US Client With SOC Code
          responses:
          - headers:
              Retry-After: unset
              Location: unset
            code: '201'
            description: Successful response of applicant onboard process of Complete state for US Client with SOC required.
            content:
              application/json:
                externalValue: ./examples/20._Hiring_an_employee_completely_for_the_US_Client_With_SOC_Code_Custom_Example_applicant.onboard_201_497840.json
          description: <p>SOC Code should be mandatory for New Hire Applicant Onboard API if SUI/SDI Tax Codes are below</p><ul><li>Indiana</li><li>Louisiana</li><li>South Carolina</li><li>Washington</li><li>West Virginia</li></ul>
          content:
            application/json:
              externalValue: ./examples/20._Hiring_an_employee_completely_for_the_US_Client_With_SOC_Code_Custom_Example_applicant.onboard_request_47069.json
        - summary: <strong>INTERNATIONAL Clients -&nbsp;</strong><span>Response using&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;as <strong>International (System)</strong> in the request.</span>
          headers:
            ADP-Context-ExpressionID: country=INT
          name: 06. Hiring an employee completely for the International Client - Full Payload
          responses:
          - headers:
              Retry-After: ''
              Location: ''
            code: '201'
            description: Successful response of applicant onboard process of Complete state for International Client.
            content:
              application/json:
                externalValue: ./examples/06._Hiring_an_employee_completely_for_the_International_Client_-_Full_Payload_Custom_Example_applicant.onboard_201_44568.json
          description: <strong>INTERNATIONAL Clients -&nbsp;</strong><span>Response using&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;as <strong>International (System)</strong> in the request.</span>
          content:
            application/json:
              externalValue: ./examples/06._Hiring_an_employee_completely_for_the_International_Client_-_Full_Payload_Custom_Example_applicant.onboard_request_3909.json
        - summary: Hiring an employee completely for the US Client with Ohio(OH) School District- Full Payload
          name: 10. Hiring an employee completely for the US Client with Ohio(OH) School District- Full Payload
          responses:
          - headers:
              Retry-After: unset
              Location: unset
            code: '201'
            description: Response of complete hire with OH school district - US
            content:
              application/json:
                externalValue: ./examples/10._Hiring_an_employee_completely_for_the_US_Client_with_Ohio(OH)_School_District-_Full_Payload_Custom_Example_applicant.onboard_201_479278.json
          description: Hiring an employee completely for the US Client with Ohio(OH) School District- Full Payload
          content:
            application/json:
              externalValue: ./examples/10._Hiring_an_employee_completely_for_the_US_Client_with_Ohio(OH)_School_District-_Full_Payload_Custom_Example_applicant.onboard_request_43679.json
        - summary: When Legal address 1 is not passed in the request
          headers:
            ADP-Context-ExpressionID: country=US
          name: 18. Bad Request - [Complete] - When Legal address 1 is not passed in the request
          responses:
          - headers:
              Content-Language: unset
              Last-Modified: unset
            code: '400'
            description: Response when legal address 1 is not passed in the request payload.
            content:
              application/json:
                externalValue: ./examples/18._Bad_Request_-_[Complete]_-_When_Legal_address_1_is_not_passed_in_the_request_Custom_Example_applicant.onboard_400_495159.json
          - headers:
              Content-Language: unset
              Last-Modified: unset
            code: '400'
            description: 'Response when payroll group code is not passed in the request.


              Refer the payload values for creating a proper request.'
            content:
              application/json:
                externalValue: ./examples/18._Bad_Request_-_[Complete]_-_When_Legal_address_1_is_not_passed_in_the_request_Custom_Example_applicant.onboard_400_495163.json
          - headers:
              Content-Language: unset
              Last-Modified: unset
            code: '400'
            description: 'Response when Secondary address city is not passed in the request.


              Refer the payload values for creating a proper request.'
            content:
              application/json:
                externalValue: ./examples/18._Bad_Request_-_[Complete]_-_When_Legal_address_1_is_not_passed_in_the_request_Custom_Example_applicant.onboard_400_495160.json
          - headers:
              Content-Language: ''
              Last-Modified: ''
            code: '400'
            description: 'Response when Applicant Onboarding Data is required.


              Refer the payload values for creating a proper request.'
            content:
              application/json:
                externalValue: ./examples/18._Bad_Request_-_[Complete]_-_When_Legal_address_1_is_not_passed_in_the_request_Custom_Example_applicant.onboard_400_495164.json
          - headers:
              Content-Language: unset
              Last-Modified: unset
            code: '400'
            description: 'Response when hire date is not passed in the request.


              Refer the payload values for creating a proper request.'
            content:
              application/json:
                externalValue: ./examples/18._Bad_Request_-_[Complete]_-_When_Legal_address_1_is_not_passed_in_the_request_Custom_Example_applicant.onboard_400_495162.json
          - headers:
              Content-Language: unset
              Last-Modified: unset
            code: '400'
            description: 'Response when federal taxFilingstatusCode is invalid in the request.


              Refer the payload values for creating a proper request.'
            content:
              application/json:
                externalValue: ./examples/18._Bad_Request_-_[Complete]_-_When_Legal_address_1_is_not_passed_in_the_request_Custom_Example_applicant.onboard_400_495161.json
          description: When Legal address 1 is not passed in the request
          content:
            application/json:
              externalValue: ./examples/18._Bad_Request_-_[Complete]_-_When_Legal_address_1_is_not_passed_in_the_request_Custom_Example_applicant.onboard_request_46242.json
        - summary: Prehire an employee for the US Client(InProgress)
          name: 12. Prehire an employee for the US Client(InProgress)
          responses:
          - headers:
              Retry-After: ''
              Location: ''
            code: '201'
            description: Response of Prehire an employee for the US Client(InProgress)
            content:
              application/json:
                externalValue: ./examples/12._Prehire_an_employee_for_the_US_Client(InProgress)_Custom_Example_applicant.onboard_201_479280.json
          description: Prehire an employee for the US Client(InProgress)
          content:
            application/json:
              externalValue: ./examples/12._Prehire_an_employee_for_the_US_Client(InProgress)_Custom_Example_applicant.onboard_request_43681.json
        - summary: Template with custom fields information for personal and employment
          name: 24. Template with custom fields
          responses:
          - headers:
              Retry-After: unset
              Location: unset
            code: '201'
            description: Applicant record is created
            content:
              application/json:
                externalValue: ./examples/24._Template_with_custom_fields_Custom_Example_applicant.onboard_201_640858.json
          description: Template with custom fields information for personal and employment
          content:
            application/json:
              externalValue: ./examples/24._Template_with_custom_fields_Custom_Example_applicant.onboard_request_62591.json
        - summary: Bad Request when pre-hire is true, but only mandatory fields are passed in the request.
          headers:
            ADP-Context-ExpressionID: country=US
          name: 16. Bad Request - when pre-hire is true, but only mandatory fields are passed in the request.
          responses:
          - headers:
              Content-Language: unset
              Last-Modified: unset
            code: '400'
            description: Response When pre-hire is true, but only mandatory fields are passed in the request
            content:
              application/json:
                externalValue: ./examples/16._Bad_Request_-_when_pre-hire_is_true,_but_only_mandatory_fields_are_passed_in_the_request._Custom_Example_applicant.onboard_400_495147.json
          description: Bad Request when pre-hire is true, but only mandatory fields are passed in the request.
          content:
            application/json:
              externalValue: ./examples/16._Bad_Request_-_when_pre-hire_is_true,_but_only_mandatory_fields_are_passed_in_the_request._Custom_Example_applicant.onboard_request_46237.json
        - summary: <p>Hiring an employee completely for the US Client with Indiana for any of below field- Full Payload</p><ol><li>worked in state or</li><li>lived in state or</li><li>SUI/SDI</li></ol><p>Job Title For Compliance Reporting and SOC Code are must pass to complete the Hire for Indiana.</p>
          headers:
            ADP-Context-ExpressionID: country=US
          name: 19. Hiring an employee completely for the US Client with Indiana - Full Payload
          responses:
          - headers:
              Retry-After: unset
              Location: unset
            code: '201'
            description: Successful response of applicant onboard process of Complete state for US Client.
            content:
              application/json:
                externalValue: ./examples/19._Hiring_an_employee_completely_for_the_US_Client_with_Indiana_-_Full_Payload_Custom_Example_applicant.onboard_201_497438.json
          description: <p>Hiring an employee completely for the US Client with Indiana for any of below field- Full Payload</p><ol><li>worked in state or</li><li>lived in state or</li><li>SUI/SDI</li></ol><p>Job Title For Compliance Reporting and SOC Code are must pass to complete the Hire for Indiana.</p>
          content:
            application/json:
              externalValue: ./examples/19._Hiring_an_employee_completely_for_the_US_Client_with_Indiana_-_Full_Payload_Custom_Example_applicant.onboard_request_46897.json
        - summary: <strong>CANADA Clients -&nbsp;</strong><span>Response using&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;as <strong>Applicant Onboard</strong> in the request.</span>
          headers:
            ADP-Context-ExpressionID: country=CA
          name: 05. Hiring an employee completely for the CANADA Client - Full Payload
          responses:
          - headers:
              Retry-After: ''
              Location: ''
            code: '201'
            description: Successful response of applicant onboard process of Complete state for CANADA Client.
            content:
              application/json:
                externalValue: ./examples/05._Hiring_an_employee_completely_for_the_CANADA_Client_-_Full_Payload_Custom_Example_applicant.onboard_201_44567.json
          description: <strong>CANADA Clients -&nbsp;</strong><span>Response using&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;as <strong>Applicant Onboard</strong> in the request.</span>
          content:
            application/json:
              externalValue: ./examples/05._Hiring_an_employee_completely_for_the_CANADA_Client_-_Full_Payload_Custom_Example_applicant.onboard_request_3908.json
        - summary: <strong>INTERNATIONAL Clients</strong><span>&nbsp;- Response when using&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;as <strong>International (System)</strong></span>
          headers:
            ADP-Context-ExpressionID: country=INT
          name: 03. Starts the applicant onboarding process (Inprogress state) for International Client - Minimal Payload
          responses:
          - headers:
              Retry-After: ''
              Location: ''
            code: '201'
            description: Successful response of applicant onboard process of Inprogress state for International Client.
            content:
              application/json:
                externalValue: ./examples/03._Starts_the_applicant_onboarding_process_(Inprogress_state)_for_International_Client_-_Minimal_Payload_Custom_Example_applicant.onboard_201_44564.json
          description: <strong>INTERNATIONAL Clients</strong><span>&nbsp;- Response when using&nbsp;</span><strong>templateNameCode</strong><span>&nbsp;as <strong>International (System)</strong></span>
          content:
            application/json:
              externalValue: ./examples/03._Starts_the_applicant_onboarding_process_(Inprogress_state)_for_International_Client_-_Minimal_Payload_Custom_Example_applicant.onboard_request_3906.json
        visibilityCodes:
        - internal
        - external
        globalViewDevPortalIndicator: true
      requestBody:
        description: Request to initiate the onboarding
        required: true
        content:
          application/json:
            schema:
              $ref: ./schemas/applicant-onboarding-schema_v02.json
      responses:
        '200':
          headers:
            ETag:
              schema:
                type: string
              description: Defines the entity tag for use with the If-Match and If-None-Match request headers.
              x-adpParameterData:
                visibilityCodes:
                - internal
                - external
              required: false
            Content-Language:
              schema:
                type: string
              x-adpParameterData:
                visibilityCodes:
                - internal
              required: false
            Last-Modified:
              schema:
                type: string
              x-adpParameterData:
                visibilityCodes:
                - internal
              required: false
          description: Applicant onboarding confirmation
          content:
            application/json:
              schema:
                $ref: ./schemas/applicant-onboarding-response-schema_v02.json
        '201':
          headers:
            Retry-After:
              schema:
                type: string
              x-adpParameterData:
                visibilityCodes:
                - internal
              required: false
            Location:
              schema:
                type: string
              x-adpParameterData:
                visibilityCodes:
                - internal
              required: false
          description: Applicant record is created
          content:
            application/json:
              schema:
                $ref: ../../../common/shared/confirm-message-schema_v03.json
        '400':
          $ref: '#/components/responses/400'
        '500':
          $ref: '#/components/responses/500'
        '412':
          $ref: '#/components/responses/412'
        '403':
          $ref: '#/components/responses/403'
        '503':
          $ref: '#/components/responses/503'
        '405':
          $ref: '#/components/responses/405'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
      description: Data related to the applicant onboarding request
      operationId: c2fe03be-a3ba-470a-88fe-ec02b2216905
      parameters:
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Acting-SessionID
        description: Session ID for the acting session in 'Act-As' and act 'On-Behalf-Of' scenarios
        x-adpParameterData:
          visibilityCodes:
          - internal
          - external
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: SOR
        description: SOR where the call is routed to.  Set up / overwritten by the infrastructure (API PRoxy) based on the user profile settings.
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Action-Reason
        description: Free format to indicate a reason for the current request
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      - schema:
          default: ''
          type: string
        in: header
        name: Authorization
        description: Provides the client's authorization token to access the resource representation at a URI
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          type: string
        in: header
        name: associateoid
        description: Associate OID of the requestor
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Consumer-ApplicationID
        description: Identifier of the application sending a request - not intended to be used as a correlation id for messages across systems participating in a collaboration
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-On-Behalf-Of-AssociateOID
        description: Associate OID for the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          type: string
        in: header
        name: roleCode
        description: 'The role the user is playing during the transaction.  Possible values: employee,manager,practitioner,administrator,supervisor.  The roleCode header should be set by the API consumer otherwise it will be defaulted to the lowest value based on the user profile settings.'
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Context-ExpressionID
        description: Geopolitical context, typically country, region, e.g. country=CA;subdivision=Quebec
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ConsumerAppOID
        description: Identifier for the service consumer application.  This header is required, if the actor (Service Consumer) is an application or the actor is internal to ADP
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Act-As-OrgOID
        description: Org OID for organization of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          type: string
        in: header
        name: orgoid
        description: Organization OID of the requestor
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: true
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-Act-As-AssociateOID
        description: Associate OID of the associate that is the actor in 'Acting As' as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: Accept-Language
        description: Accept-Language:language|*;q=qvalue. Specifies the language(s) that are acceptable for the response. The optional qvalue represents a quality level for acceptable languages.
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: ADP-On-Behalf-Of-OrgOID
        description: Org OID for organization of the associate that is the actor in ' On Behalf Of' as provisioned by the ADP Registry
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      - schema:
          default: ''
          type: string
        in: header
        name: SORContext
        description: Context within an SOR that the call should be routed to.  Set up / overwritten by the infrastructure (API PRoxy) based on the user profile settings.
        x-adpParameterData:
          visibilityCodes:
          - internal
        required: false
      tags:
      - Onboarding Process Management
components:
  responses:
    '429':
      headers:
        Content-Language:
          schema:
            type: string
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Last-Modified:
          schema:
            type: string
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
      description: Too Many Requests
      content:
        application/json:
          schema:
            $ref: ../../../common/shared/confirm-message-schema_v03.json
    '406':
      headers:
        Content-Language:
          schema:
            type: string
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Last-Modified:
          schema:
            type: string
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
      description: Not Acceptable
      content:
        application/json:
          schema:
            $ref: ../../../common/shared/confirm-message-schema_v03.json
    '403':
      headers:
        Content-Language:
          schema:
            type: string
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Last-Modified:
          schema:
            type: string
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: ../../../common/shared/confirm-message-schema_v03.json
    '405':
      headers:
        Content-Language:
          schema:
            type: string
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Last-Modified:
          schema:
            type: string
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
      description: Method Not Allowed
      content:
        application/json:
          schema:
            $ref: ../../../common/shared/confirm-message-schema_v03.json
    '500':
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: ../../../common/shared/confirm-message-schema_v03.json
    '503':
      description: Service Unavailable
      content:
        application/json:
          schema:
            $ref: ../../../common/shared/confirm-message-schema_v03.json
    '400':
      headers:
        Content-Language:
          schema:
            type: string
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Last-Modified:
          schema:
            type: string
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: ../../../common/shared/confirm-message-schema_v03.json
    '412':
      headers:
        Content-Language:
          schema:
            type: string
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
        Last-Modified:
          schema:
            type: string
          x-adpParameterData:
            visibilityCodes:
            - internal
          required: false
      description: Precondition Failed
      content:
        application/json:
          schema:
            $ref: ../../../common/shared/confirm-message-schema_v03.json
x-adpSpecData:
  domain: HCM
  specId: a0d18d20-3d21-482e-b257-7e59c9a33feb
  canonicalSpecId: 1d8a3771-a45c-45d2-9d55-8e59a91e177a
  specStatusCode: publishing
  specTypeCode: REST
  specStateCode: active
  nonStandardIndicator: false
  visibilityCodes:
  - internal
  - external
  filename: applicant-onboarding-swagger_v2-merged.json
  serviceProviderId: WFN
  resourcePath: hcm/applicant-onboarding/v2
  libraryVersion: ''
  testCaseCollection:
    example:
      href: ApplicantOnboarding_WFNCurrentGen.postman_collection.json
    description: Applicant Onboard Postman Collection
  publicationContext:
    products:
    - productId: hcm-offrg-wfn
      productName: workforce now
      marketplaceProductName: ADP Workforce Now®
  specCategoryCode: ''