lead for request loan

Get Loan Application Details

This endpoint retrieves the current loan lead and owner request details associated with a business customer's funding application. It returns a structured payload containing business information (item1) and the list of significant persons (owners/principals) (item2) that form the basis of a loan submission. Use this endpoint to inspect or confirm the data on file before submitting or updating a loan application.

Endpoint

GET /api/loans/details

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint when a partner needs to retrieve the existing loan lead details for a business customer, such as before displaying a pre-filled loan application form or verifying that all required business and owner information is present prior to submission. This is typically called as a read step in a loan application workflow for business customers only — personal customers are not eligible for business funding.

Response

200 OK

The response is a tuple object with two top-level items:

Top-level fields

FieldTypeDescription
item1objectLead request object containing business and loan details
item2objectOwner request object containing significant persons (principals/owners)

item1 — Lead Request (youlend.client.model.leadrequest)

FieldTypeDescription
countryISOCodestringISO 3166-1 alpha-2 country code for the business (e.g., "US")
companyTypestringLegal entity type of the business (e.g., "LLC", "Corporation")
registeredAddressobjectRegistered address of the business (see registeredAddress fields below)
thirdPartyCustomerIdstringPartner-assigned external customer identifier
companyNamestringLegal name of the business
loanCurrencyISOCodestringISO 4217 currency code for the requested loan (e.g., "USD")
keyContactNamestringFull name of the primary business contact
contactPhoneNumberstringPhone number of the primary business contact
contactEmailAddressstringEmail address of the primary business contact
loanAmountintegerRequested loan amount in the smallest currency unit (e.g., cents)
signupClientIpstringIP address of the client at the time of signup
employerIdentificationNumberstringBusiness EIN (sanitized in examples)
companyWebsitestringURL of the business website
preApprovalIdstringPre-approval identifier, if a pre-approval offer was issued
ConfirmedCreditSearchbooleanWhether the applicant has consented to a credit search

item1.registeredAddress — Registered Address (youlend.client.model.registeredaddress)

FieldTypeDescription
line1stringPrimary street address line
line2stringSecondary address line (suite, unit, etc.)
citystringCity name
regionstringState or region code (e.g., "TX")
areaCodestringPostal or ZIP code
countrystringCountry name or code

item2 — Owner Request (youlend.client.model.ownerrequest)

FieldTypeDescription
significantPersonsarray of objectsList of principals, owners, or other significant persons associated with the business

item2.significantPersons[] — Significant Person (youlend.client.model.significantperson)

FieldTypeDescription
typeOfPersonstringRole of the person (e.g., "Owner", "Director")
addressobjectResidential address of the significant person (same structure as registeredAddress)
dateOfBirthobjectDate of birth broken into year, month, and day components
dateOfBirth.yearintegerFour-digit birth year
dateOfBirth.monthintegerBirth month (1–12)
dateOfBirth.dayintegerBirth day (1–31)
firstNamestringFirst name of the significant person
surnamestringLast name of the significant person
emailAddressstringEmail address of the significant person
mobilePhoneNumberstringMobile phone number of the significant person
socialSecurityNumberstringSSN of the significant person (sanitized; never log or display)
{
  "item1": {
    "countryISOCode": "US",
    "companyType": "LLC",
    "registeredAddress": {
      "line1": "123 Commerce Blvd",
      "line2": "Suite 400",
      "city": "Austin",
      "region": "TX",
      "areaCode": "78701",
      "country": "US"
    },
    "thirdPartyCustomerId": "partner-cust-00123",
    "companyName": "Acme Business Solutions LLC",
    "loanCurrencyISOCode": "USD",
    "keyContactName": "Jane Smith",
    "contactPhoneNumber": "+15125550100",
    "contactEmailAddress": "[email protected]",
    "loanAmount": 50000,
    "signupClientIp": "203.0.113.45",
    "employerIdentificationNumber": "XX-XXXXXXX",
    "companyWebsite": "https://www.acmebusiness.com",
    "preApprovalId": "preapproval-abc-789",
    "ConfirmedCreditSearch": true
  },
  "item2": {
    "significantPersons": [
      {
        "typeOfPerson": "Owner",
        "address": {
          "line1": "456 Residential St",
          "line2": "",
          "city": "Austin",
          "region": "TX",
          "areaCode": "78702",
          "country": "US"
        },
        "dateOfBirth": {
          "year": 1980,
          "month": 6,
          "day": 15
        },
        "firstName": "Jane",
        "surname": "Smith",
        "emailAddress": "[email protected]",
        "mobilePhoneNumber": "+15125550101",
        "socialSecurityNumber": "XXX-XX-XXXX"
      }
    ]
  }
}

Error Codes

CodeWhen it happens
401Token missing, expired, or invalid
403Insufficient permissions; caller is not authorized to access loan details for this business profile
404No loan application details found for the given customer
500Internal server error

Common Mistakes

  • Calling this endpoint for a personal customer — business funding is available to business customers only; personal customer profiles will not have loan details.
  • Logging or displaying the socialSecurityNumber field in plain text — always treat this value as sensitive and mask or omit it in any UI or log output.
  • Treating loanAmount as a decimal dollar value — the field is an integer representing the amount in the smallest currency unit (cents for USD).
  • Ignoring a null response for preApprovalId — a null value means no pre-approval offer exists; do not pass a blank string to downstream endpoints expecting a valid pre-approval ID.

Related Endpoints

  • POST /api/auth/v2 — Obtain a Bearer token required for all API calls
  • POST /api/loans/apply — Submit or update a business funding application using the details retrieved here
  • GET /api/loans/status — Check the current status of a submitted loan application

Example

curl -X GET https://api.banking.netevia.dev/api/loans/details \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json