Get Applicant API: Retrieving Applicant Details (GET /applicant)

Overview

The Get Applicant API lets partners retrieve an applicant's profile using the identifiers provided by webhooks or other Double Nickel APIs: stage and status (including transition dates), contact details, job and source information, the assigned recruiter and members, hiring-step progress, address history, license details, equipment, and custom question/field values.

For authentication, environments, and error conventions shared by all endpoints, see "Double Nickel API: Getting Started & Creating Applicants". This endpoint requires the read:applicants scope on your credential.

Endpoint

GET https://dashboard.getdoublenickel.com/api/applicant?applicantId=<applicantId>&companyId=<companyId>

Query parameters

Name	Type	Required	Description
`applicantId`	string	Yes	Applicant ID received from a webhook or API (10–100 characters)
`companyId`	string	Yes	Your Double Nickel company identifier (10–100 characters)

Request headers

Header	Value
`Authorization`	`Bearer <access_token>`
`Auth-provider`	`auth0`
`Accept`	`application/json`

Successful response (200)

{
  "data": {
    "applicantId": "clxyz1234567890abcdef",
    "stage": {
      "applicantStage": "PROSPECT",
      "applicantStageDate": "2026-03-18T00:00:00.000Z",
      "hiringStage": "ONBOARDING",
      "hiredDate": null,
      "disqualifiedReason": null,
      "disqualifiedDate": null,
      "notInterestedReason": null,
      "notInterestedDate": null,
      "terminatedReason": null,
      "terminatedDate": null
    },
    "status": "ACTIVE",
    "outreach": {
      "callCount": 5,
      "missedOutboundCallCount": 2,
      "lastContactDate": "2026-06-01T14:30:00.000Z"
    },
    "personalInformation": {
      "firstName": "John",
      "middleName": "Michael",
      "lastName": "Smith",
      "phone": "+15551234567",
      "email": "[email protected]",
      "ssn": "123-45-6789",
      "dateOfBirth": "1990-05-15T00:00:00.000Z"
    },
    "jobInformation": {
      "jobListingId": "clxyz1234567890joblist",
      "jobListingTitle": "OTR CDL-A Driver",
      "availableForWorkDate": "2026-07-01T00:00:00.000Z",
      "trackingLinkId": "clxyz1234567890trklink",
      "trackingLinkType": "REFERRAL",
      "trackingLinkName": "Indeed Campaign Q1"
    },
    "leadEmployee": {
      "employeeId": "clxyz1234567890emp01",
      "email": "[email protected]",
      "firstName": "Jane",
      "lastName": "Doe"
    },
    "memberEmployees": [
      {
        "employeeId": "clxyz1234567890emp02",
        "email": "[email protected]",
        "firstName": "Sam",
        "lastName": "Jones"
      }
    ],
    "steps": [
      {
        "stepId": "clxyz1234567890step01",
        "type": "DOT_APP",
        "status": "COMPLETED",
        "isActive": true,
        "customStepId": null,
        "customStepLabel": null,
        "updatedAt": "2026-06-10T18:00:00.000Z"
      },
      {
        "stepId": "clxyz1234567890step02",
        "type": "BACKGROUND_CHECK",
        "status": "PENDING_REVIEW",
        "isActive": true,
        "customStepId": null,
        "customStepLabel": null,
        "updatedAt": "2026-06-12T09:30:00.000Z"
      },
      {
        "stepId": "clxyz1234567890step03",
        "type": "CUSTOM",
        "status": "NOT_STARTED",
        "isActive": true,
        "customStepId": "clxyz1234567890cstep1",
        "customStepLabel": "Orientation Scheduling",
        "updatedAt": "2026-06-01T12:00:00.000Z"
      }
    ],
    "addresses": [
      {
        "addressId": "clxyz1234567890addr01",
        "street": "123 Main St",
        "city": "Dallas",
        "state": "TX",
        "country": "US",
        "zipCode": "75201",
        "startDate": "2022-01-01T00:00:00.000Z",
        "endDate": null
      }
    ],
    "license": {
      "licenseId": "clxyz1234567890licens",
      "licenseNumber": "DL12345678",
      "licenseClass": "A",
      "state": "TX",
      "country": "US",
      "expirationDate": "2027-08-15T00:00:00.000Z",
      "medicalExamExpirationDate": "2026-12-01T00:00:00.000Z",
      "endorsements": ["H", "N"],
      "isLicenseSuspended": false,
      "licenseSuspendedReason": null
    },
    "equipments": [
      {
        "equipmentId": "clxyz1234567890equip1",
        "type": "TRACTOR",
        "year": 2021,
        "make": "Freightliner",
        "model": "Cascadia",
        "color": "White",
        "vin": "1FUJGLDR5CLBK1234",
        "weight": 18000,
        "mileage": 350000,
        "fifthWheelHeightInches": 48
      }
    ],
    "customQuestions": [
      {
        "answerId": "clxyz1234567890answr1",
        "questionId": "clxyz1234567890quest1",
        "type": "SHORT_TEXT",
        "question": "What is your preferred route type?",
        "key": "preferred_route_type",
        "answer": "Regional, Southeast"
      }
    ],
    "customFields": [
      {
        "fieldId": "clxyz1234567890field1",
        "key": "hire_source",
        "label": "Hire Source",
        "type": "SINGLE_SELECT",
        "value": ["Indeed"]
      }
    ],
    "archivedCustomFields": [
      {
        "fieldId": "clxyz1234567890field2",
        "key": "legacy_driver_code",
        "label": "Legacy Driver Code",
        "type": "STRING",
        "value": "DRV-0042"
      }
    ]
  }
}

Field reference

Top level

Field	Type	Description
`applicantId`	string	Unique identifier for the applicant
`status`	string	`ACTIVE` or `ARCHIVED`

`stage`

Field	Type	Description
`applicantStage`	string	One of `PROSPECT`, `HIRED`, `DISQUALIFIED`, `NOT_INTERESTED`, `TERMINATED`
`applicantStageDate`	string \| null	When the applicant entered the current stage (ISO 8601)
`hiringStage`	string \| null	Sub-stage within `PROSPECT`: `LEAD`, `APPLICATION`, `QUALIFICATION`, or `ONBOARDING`
`hiredDate`	string \| null	When the applicant was moved to `HIRED` (ISO 8601), stamped at the stage transition
`disqualifiedReason` / `disqualifiedDate`	string \| null	Reason and timestamp when disqualified
`notInterestedReason` / `notInterestedDate`	string \| null	Reason and timestamp when marked not interested
`terminatedReason` / `terminatedDate`	string \| null	Reason and timestamp when terminated

`outreach`

Field	Type	Description
`callCount`	integer	Total calls with the applicant
`missedOutboundCallCount`	integer	Outbound calls the applicant did not answer
`lastContactDate`	string \| null	Most recent contact (ISO 8601)

`personalInformation`

Field	Type	Description
`firstName` / `middleName` / `lastName`	string (middle: string \| null)	Applicant's name
`phone`	string	Phone number in E.164 format
`email`	string	Email address
`ssn`	string \| null	Social Security Number, from the application
`dateOfBirth`	string \| null	Date of birth (ISO 8601), from the application

`jobInformation`

Field	Type	Description
`jobListingId` / `jobListingTitle`	string \| null	Associated job listing
`availableForWorkDate`	string \| null	Date the applicant indicated they are available to start (ISO 8601)
`trackingLinkId` / `trackingLinkType` / `trackingLinkName`	string \| null	Source attribution of the application (e.g. `REFERRAL`, `INDEED`, `COMPANY_WEBSITE`)

`leadEmployee` and `memberEmployees`

leadEmployee is the recruiter assigned to lead this applicant (null when unassigned). memberEmployees lists additional team members assigned to the applicant (empty array when none). Each contains employeeId, email, firstName, and lastName.

`steps`

The applicant's hiring-step checklist, ordered by creation. Useful for checking which pre-hire items are complete before orientation.

Field	Type	Description
`stepId`	string	Unique identifier for the step
`type`	string	One of `DOT_APP`, `MVR`, `PSP`, `BACKGROUND_CHECK`, `CLEARINGHOUSE`, `CDL`, `CDLIS`, `DOT_MEDICAL`, `VERIFICATION_OF_EMPLOYMENT`, `DRUG_AND_ALCOHOL_TESTING`, `SHORT_FORM`, `ROAD_TEST`, `CUSTOM`
`status`	string	One of `NOT_STARTED`, `IN_PROGRESS`, `PENDING_REVIEW`, `COMPLETED`
`isActive`	boolean	Whether the step is currently part of the applicant's checklist
`customStepId` / `customStepLabel`	string \| null	For `CUSTOM` steps, the company-defined step and its label
`updatedAt`	string	Last time the step changed (ISO 8601)

`addresses`

Address history from the application: addressId, street, city, state, country, zipCode, startDate, endDate (null for the current address).

`license`

Field	Type	Description
`licenseNumber`	string \| null	Current license number
`licenseClass`	string \| null	One of `A`, `B`, `C`, `D`, `E`, `F`, `NO_CDL`
`state` / `country`	string \| null	Issuing state and country
`expirationDate`	string \| null	License expiration (ISO 8601)
`medicalExamExpirationDate`	string \| null	DOT medical exam expiration (ISO 8601)
`endorsements`	string[]	Endorsement codes: `H` (Hazmat), `N` (Tank), `X` (Tank + Hazmat), `P` (Passenger), `S` (School Bus), `T` (Doubles/Triples), `V` (Tank w/ Hazmat), `L` (Air Brake Restriction), `M` (Metal Coil)
`isLicenseSuspended` / `licenseSuspendedReason`	boolean / string \| null	Suspension flag and reason

`equipments`

Owner-operator equipment from the application: equipmentId, type, year, make, model, color, vin, weight, mileage, fifthWheelHeightInches.

`customQuestions`, `customFields`, `archivedCustomFields`

customQuestions — answers to your company's custom application questions. Only private (recruiter-facing), non-archived questions are returned; each entry includes the question key, type, question text, and the formatted answer.
customFields — values of your company's active custom applicant fields (value is an array for select-type fields).
archivedCustomFields — values of custom fields that have since been archived, kept for historical reference.

What this endpoint does not include

Employment history, accident/violation records, and other narrative DOT application sections are not returned by this endpoint. The applicant's completed, signed application PDF — which contains those sections — is available through the Documents API under category DOT_APP.

Error responses

HTTP status	Error code	Example message
400	`missing_parameter`	Applicant ID is required.
400	`invalid_parameter`	Invalid applicant ID format.
401	`unauthorized`	The authorization token is not valid.
403	`forbidden`	You do not have permission to access this resource. (missing `read:applicants` scope)
404	`not_found`	Applicant not found.
405	`method_not_allowed`	Method POST not allowed. Only GET is supported.
500	`internal_error`	Error processing request.

Questions or need help?

Contact the Double Nickel support team at [email protected].

Documents API: Retrieving Applicant Documents (GET /documents)

Get Applicant API: Retrieving Applicant Details (GET /applicant)

Overview

Endpoint

Query parameters

Request headers

Successful response (200)

Field reference

Top level

stage

outreach

personalInformation

jobInformation

leadEmployee and memberEmployees

steps

addresses

license

equipments

customQuestions, customFields, archivedCustomFields