---
updatedAt: 2026-08-27T13:52:09.000Z
agentTools:
  projectIndex: https://docs.youlend.com/llms.txt
---

# Retrieve organisation details.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Onboarding",
    "description": "Through this API you can can initiate the process of onboarding a borrower with YouLend",
    "contact": {
      "name": "Mark Ufland",
      "email": "mark.ufland@youlend.com"
    },
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://partners.staging-youlendapi.com/onboarding"
    }
  ],
  "paths": {
    "/Leads/{leadId}/organisationdetails": {
      "get": {
        "tags": [
          "GET Details"
        ],
        "summary": "Retrieve organisation details.",
        "parameters": [
          {
            "name": "leadId",
            "in": "path",
            "description": "The lead id.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrganisationDetailsStepView"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/OrganisationDetailsStepView"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Address": {
        "type": "object",
        "properties": {
          "addressLine1": {
            "type": "string",
            "nullable": true
          },
          "addressLine2": {
            "type": "string",
            "nullable": true
          },
          "addressLine3": {
            "type": "string",
            "nullable": true
          },
          "city": {
            "type": "string",
            "nullable": true
          },
          "region": {
            "type": "string",
            "nullable": true
          },
          "postcode": {
            "type": "string",
            "nullable": true
          },
          "country": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "Industry": {
        "required": [
          "code",
          "description"
        ],
        "type": "object",
        "properties": {
          "code": {
            "minLength": 1,
            "type": "string",
            "description": "Gets or sets the SIC code for the industry."
          },
          "description": {
            "maxLength": 255,
            "minLength": 1,
            "type": "string",
            "description": "Gets or sets the description of the industry."
          }
        },
        "additionalProperties": false,
        "description": "Model representing an industry."
      },
      "OrganisationDetails": {
        "type": "object",
        "properties": {
          "leadId": {
            "type": "string",
            "description": "Gets or sets the lead id.",
            "format": "uuid"
          },
          "companyName": {
            "type": "string",
            "description": "Gets or sets the company name.",
            "nullable": true
          },
          "tradingName": {
            "type": "string",
            "description": "Gets or sets the trading name.",
            "nullable": true
          },
          "companyNumber": {
            "type": "string",
            "description": "Gets or sets the company number.",
            "nullable": true
          },
          "vatNumber": {
            "type": "string",
            "description": "Gets or sets the VAT number for the organisation.",
            "nullable": true
          },
          "formationDate": {
            "type": "string",
            "description": "Gets or sets the formation date for the organisation.",
            "format": "date-time"
          },
          "companyType": {
            "type": "string",
            "description": "Gets or sets the key merchant company type.",
            "nullable": true
          },
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "country": {
            "type": "string",
            "description": "Gets or sets the country ISO code for the organisation.",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "Gets or sets the description for the company.",
            "nullable": true
          },
          "keyContactName": {
            "type": "string",
            "description": "Gets or sets the key merchant contact who will be setting up the loan.",
            "nullable": true
          },
          "website": {
            "type": "string",
            "description": "Gets or sets the organisation website URL.",
            "nullable": true
          },
          "phoneNumber": {
            "type": "string",
            "description": "Gets or sets the organisation phone number.",
            "nullable": true
          },
          "email": {
            "type": "string",
            "description": "Gets or sets the organisation email address.",
            "nullable": true
          },
          "significantPersons": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SignificantPerson"
            },
            "description": "Gets or sets the list of significant persons.",
            "nullable": true
          },
          "industries": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Industry"
            },
            "description": "Gets or sets the list of industries in which the organisation conducts business.",
            "nullable": true
          },
          "confirmedCreditSearch": {
            "type": "boolean",
            "description": "Gets or sets a value indicating whether the organisation consents to a credit search."
          },
          "employerIdentificationNumber": {
            "type": "string",
            "description": "Gets or sets the merchants tax identification number (required for USA).",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Model for the organisation details for a loead."
      },
      "OrganisationDetailsStepView": {
        "type": "object",
        "properties": {
          "leadId": {
            "type": "string",
            "description": "Gets or sets the lead id.",
            "format": "uuid"
          },
          "preApprovalId": {
            "type": "string",
            "format": "uuid"
          },
          "organisationDetails": {
            "$ref": "#/components/schemas/OrganisationDetails"
          }
        },
        "additionalProperties": false,
        "description": "A model containing data about organisations details step for a lead."
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": {}
      },
      "SignificantPerson": {
        "type": "object",
        "properties": {
          "personId": {
            "type": "string",
            "format": "uuid"
          },
          "firstName": {
            "type": "string",
            "nullable": true
          },
          "surname": {
            "type": "string",
            "nullable": true
          },
          "typeOfPerson": {
            "type": "string",
            "nullable": true
          },
          "address": {
            "$ref": "#/components/schemas/Address"
          },
          "dateOfBirth": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "percentageOwned": {
            "type": "number",
            "format": "double"
          },
          "email": {
            "type": "string",
            "nullable": true
          },
          "mobileNumber": {
            "type": "string",
            "nullable": true
          },
          "nationality": {
            "type": "string",
            "nullable": true
          },
          "niNumber": {
            "type": "string",
            "nullable": true
          },
          "socialSecurityNumber": {
            "type": "string",
            "nullable": true
          },
          "placeOfBirth": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://youlend-stag.eu.auth0.com/oauth/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "security": [
    {
      "oauth2": []
    }
  ],
  "tags": [
    {
      "name": "GET Details"
    }
  ]
}
```