---
title: "Retrieve onboarding details."
method: GET
path: "/Leads/{leadId}/details"
tags: ["GET Details"]
---

# Retrieve onboarding details.

`GET /Leads/{leadId}/details`

## Request

- Base URL: `https://partners.staging-youlendapi.com/onboarding`
- URL: `https://partners.staging-youlendapi.com/onboarding/Leads/{leadId}/details`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://youlend-stag.eu.auth0.com/oauth/token`

You can use this endpoint to see which steps are completed and which are uncompleted for a lead.

## Path parameters

- `leadId` string, uuid, required

## Headers

- `api-version` string

## Response `200`

OK

- OnboardingView: A model containing data about an onboarding for a lead.
  - `leadSourceLendingPartnerId` string, uuid
  - `onboardingState` string, nullable: Gets or sets the current state of an onboarding. One of "stage1incomplete", "stage1submitted", "stage1rejected", "offersProvided", "offerAccepted", "offersExpired", "contractsigned", "stage2submitted", "stage2rejected" or "onboardingcomplete".
  - `onboardingStateReason` string, nullable: Gets or sets the reason for the current state of an onboarding in case of rejection.
  - `organisationDetailsStepComplete` boolean: Gets or sets a value indicating whether the organisation details step is complete.
  - `paymentDataStepComplete` boolean: Gets or sets a value indicating whether the payment data step is complete.
  - `offerStepComplete` boolean: Gets or sets a value indicating whether the offer step is complete. The offer step requires the documents to be signed.
  - `kycDocumentsStepComplete` boolean: Gets or sets a value indicating whether the KYC documents step is complete.
  - `companyName` string, nullable: Gets or sets the name of the company.
  - `leadType` string, nullable: Gets or sets the lead type.
  - `isRenewal` boolean: Gets or sets a value indicating whether the lead is a renewal type.
  - `signingDetails` SigningDetails: Gets or sets the signing details for the lead.
    - `eligibleForInstantSigning` boolean: Gets or sets a value indicating whether the merchant is eligible for instant signing.
    - `instantSigningDetails` InstantSigningDetailsModel
      - `leadId` string, uuid
      - `documentId` string, uuid
      - `documentName` string, nullable
      - `signatoryName` string, nullable
      - `companyname` string, nullable
  - `owner` string, nullable: Gets or sets the lead owner name.
  - `ownerEmail` string, nullable: Gets or sets the registered email of the owner.
  - `thirdPartyCustomerId` string, nullable: Gets or sets the third party customer id.
  - `preApprovalId` string, uuid: Gets or sets the PreApproval Id.
  - `partnerLoanType` string, nullable: Gets or sets the Partner Loan Type - "Initial", "Early Renewal" or "Renewal".
  - `signUpDate` string, date-time: Gets or sets the lead signup date.
  - `stateUpdated` string, date-time: Gets or sets the date lead state is updated.
  - `merchantIds` string[], nullable: Gets or sets the list of merchant ids.
  - `additionalInfo` object, nullable: Gets or sets the dictionary of additional info.
  - `preferredRepaymentMethod` string, nullable: Gets or sets the preferred repayment method for the merchant.
  - `productType` string, nullable: Gets or sets the product type.

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/youlend/apis/onboarding.md) - [All operations](https://skmtc.dev/youlend/apis/onboarding/llms.txt) - [OpenAPI document](https://skmtc.dev/youlend/apis/onboarding/revisions/32aa9c8d752a?raw)