---
title: "POST /v1/Company/{partnerEmployerId}/Requestor/{partnerCustomerId}/PartnerAppAccess/StepCheckout"
method: POST
path: "/v1/Company/{partnerEmployerId}/Requestor/{partnerCustomerId}/PartnerAppAccess/StepCheckout"
tags: ["Partner API"]
---

# POST /v1/Company/{partnerEmployerId}/Requestor/{partnerCustomerId}/PartnerAppAccess/StepCheckout

`POST /v1/Company/{partnerEmployerId}/Requestor/{partnerCustomerId}/PartnerAppAccess/StepCheckout`

## Request

- Base URL: `https://api.goodhire.com`
- URL: `https://api.goodhire.com/v1/Company/{partnerEmployerId}/Requestor/{partnerCustomerId}/PartnerAppAccess/StepCheckout`
- Auth: none declared
- TypeScript: <https://skmtc.dev/goodhire/apis/my-api/docs/v1/Company/:partnerEmployerId/Requestor/:partnerCustomerId/PartnerAppAccess/StepCheckout/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `partnerEmployerId` string, required
- `partnerCustomerId` string, required

## Request body

- StepCheckoutRequestApi
  - `Id` string
  - `Candidate` HiringCandidateRequestApi, required
    - `FirstName` string, required
    - `MiddleName` string
    - `LastName` string, required
    - `Email` string, required
    - `SSN` string
    - `NPI` string
    - `ReferenceCode` string
    - `BillingCode` string
    - `DateOfBirth` string, date-time
    - `Phone` string, required
    - `PhoneType` 'Mobile' | 'Home' | 'Work' | 'Fax', required
    - `AddressLine` string
    - `Address` string
    - `City` string
    - `State` string
    - `Zip` string
    - `MotherMaidenName` string, required
    - `DriverLicenseNumber` string, required
    - `PassportNumber` string, required
    - `PlaceOfBirth` string, required
    - `BiologicalSex` string, required
    - `CandidateDriverRecords` HiringCandidateDriverRecordRequestApi[]
      - `FirstName` string
      - `MiddleName` string
      - `LastName` string
      - `DriverLicenseNum` string
      - `DriverLicenseState` string
      - `ValidationErrors` ValidationResult[]
        - `MemberNames` string[]
        - `ErrorMessage` string
    - `CandidateDrugTests` HiringCandidateDrugTestRequestApi[]
      - `PhoneDayTime` string
      - `PhoneEvening` string
      - `DrugTestProviderRegistrationId` string
      - `DrugTestProviderOrderId` string
      - `Gender` string
    - `CandidateEmployments` HiringCandidateEmploymentRequestApi[]
      - `CompanyName` string
      - `Title` string
      - `Salary` string
      - `Alias` string
      - `ReasonForLeaving` string
      - `EmployerContactFullName` string
      - `EmployerContactPhone` string
      - `ContactEmail` string
      - `StartMonth` integer
      - `StartYear` integer
      - `EndMonth` integer
      - `EndYear` integer
      - `IsCurrentlyEmployed` boolean
      - `CompanyAddress` string
      - `City` string
      - `State` string
      - `Comments` string
    - `CandidateLegalLocations` HiringCandidateLegalLocationRequestApi[]
      - `City` string
      - `State` string
      - `ZIP` string
      - `County` string
      - `ValidationErrors` ValidationResult[]
        - `MemberNames` string[]
        - `ErrorMessage` string
    - `CandidateCriminalStates` HiringCandidateCriminalStateRequestApi[]
      - `State` string
      - `ValidationErrors` ValidationResult[]
        - `MemberNames` string[]
        - `ErrorMessage` string
    - `CandidateLicenses` HiringCandidateLicenseRequestApi[]
      - `LicenseType` string
      - `StateIssued` string
      - `LicenseAuthorityName` string
      - `LicenseAuthorityPhone` string
      - `LicenseNumber` string
      - `IssuedDate` string, date-time
      - `ExpirationDate` string, date-time
      - `Status` string
      - `ApplicantPhoneNumber` string
      - `ValidationErrors` ValidationResult[]
        - `MemberNames` string[]
        - `ErrorMessage` string
    - `CandidateSchools` HiringCandidateSchoolRequestApi[]
      - `InstitutionName` string
      - `Address` string
      - `City` string
      - `Region` string
      - `PostalCode` string
      - `Country` string
      - `Telephone` string
      - `Fax` string
      - `EnrollmentName` string
      - `Degree` string
      - `StudyMajor` string
      - `EnrollmentStartMonth` integer
      - `EnrollmentStartYear` integer
      - `GraduationMonth` integer
      - `GraduationYear` integer
      - `IsCurrentlyEnrolled` boolean
      - `Comments` string
    - `CandidateInternationalCriminals` HiringCandidateInternationalCriminalRequestApi[]
      - `Country` string, required
    - `CandidateAliases` HiringCandidateAliasRequestApi[]
      - `FirstName` string
      - `MiddleName` string
      - `LastName` string, required
      - `ValidationErrors` ValidationResult[]
        - `MemberNames` string[]
        - `ErrorMessage` string
  - `Offer` HiringProductRequestApi, required
    - `CatalogId` string
    - `Products` string[]
    - `ValidationErrors` ValidationResult[]
      - `MemberNames` string[]
      - `ErrorMessage` string
  - `RequestOptions` PartnerAppAccessOptionsApi
    - `SendPurchaseReceipt` boolean
    - `UrlCancel` string
    - `UrlCallback` string
    - `AffiliateId` string
    - `IsAllowedToUpdateOffer` boolean
    - `SuppressCandidateSelfCompleteEmails` boolean
    - `SuppressCandidateConsentEmails` boolean
    - `SuppressCandidatePHMConsentEmails` boolean
    - `SuppressCandidateDrugConsentEmails` boolean
    - `IsPermissionToContactCurrentEmployerProvided` boolean
    - `PermissionToContactCurrentEmployerAfter` string, date-time
    - `ConsentReceived` boolean
    - `DrugConsentReceived` boolean
  - `Coupons` string[]

## Response `200`

OK

- object

---

[API](https://skmtc.dev/goodhire/apis/my-api.md) - [All operations](https://skmtc.dev/goodhire/apis/my-api/llms.txt) - [OpenAPI document](https://skmtc.dev/goodhire/apis/my-api/revisions/b7be40b187ed?raw)