YOyoulend
GET Details

Retrieve onboarding details.

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

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

Path parameters

leadIdstring uuid required

The lead id.

Headers

api-versionstring

Response

OK

leadSourceLendingPartnerIdstring uuid
onboardingStatestring nullable

Gets or sets the current state of an onboarding. One of "stage1incomplete", "stage1submitted", "stage1rejected", "offersProvided", "offerAccepted", "offersExpired", "contractsigned", "stage2submitted", "stage2rejected" or "onboardingcomplete".

onboardingStateReasonstring nullable

Gets or sets the reason for the current state of an onboarding in case of rejection.

organisationDetailsStepCompleteboolean

Gets or sets a value indicating whether the organisation details step is complete.

paymentDataStepCompleteboolean

Gets or sets a value indicating whether the payment data step is complete.

offerStepCompleteboolean

Gets or sets a value indicating whether the offer step is complete. The offer step requires the documents to be signed.

kycDocumentsStepCompleteboolean

Gets or sets a value indicating whether the KYC documents step is complete.

companyNamestring nullable

Gets or sets the name of the company.

leadTypestring nullable

Gets or sets the lead type.

isRenewalboolean

Gets or sets a value indicating whether the lead is a renewal type.

ownerstring nullable

Gets or sets the lead owner name.

ownerEmailstring nullable

Gets or sets the registered email of the owner.

thirdPartyCustomerIdstring nullable

Gets or sets the third party customer id.

preApprovalIdstring uuid

Gets or sets the PreApproval Id.

partnerLoanTypestring nullable

Gets or sets the Partner Loan Type - "Initial", "Early Renewal" or "Renewal".

signUpDatestring date-time

Gets or sets the lead signup date.

stateUpdatedstring date-time

Gets or sets the date lead state is updated.

merchantIdsstring[] nullable

Gets or sets the list of merchant ids.

additionalInfoobject nullable

Gets or sets the dictionary of additional info.

preferredRepaymentMethodstring nullable

Gets or sets the preferred repayment method for the merchant.

productTypestring nullable

Gets or sets the product type.

Changes

No recorded changes to this operation across all 1 revision of this API.