---
updatedAt: 2026-07-07T11:08:04.000Z
agentTools:
  projectIndex: https://docs.youlend.com/llms.txt
---

# Retrieve a loan by loan id

> 🚧 FAQ
>
> currentAmount is the balance outstanding.
>
> fundedAmount is the amount that the customer borrowed. Equivalent to youWillGet in the Onboarding API.
>
> originalAmount is the amount that the customer borrowed plus the fee YouLend charged. i.e. the total amount that the customer needs to repay. Equivalent to youWillRepay in the Onboarding API.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Third Party Loan API",
    "version": "v2.0"
  },
  "servers": [
    {
      "url": "https://partners.staging-youlendapi.com/loan"
    }
  ],
  "paths": {
    "/Loans/{loanId}": {
      "get": {
        "tags": [
          "Loans"
        ],
        "summary": "Retrieve a loan by loan id",
        "operationId": "GetLoan",
        "parameters": [
          {
            "name": "loanId",
            "in": "path",
            "description": "Loan ID (a GUID)",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Loan ID (a GUID)",
              "format": "uuid"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Loan successfully retrieved",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/LoanModelExtended"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LoanModelExtended"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LoanModelExtended"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/LoanModelExtended"
                }
              }
            }
          },
          "400": {
            "description": "No loan was found... please check your Loan ID",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized request! Please check your bearer token",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ProblemDetails": {
        "type": "object",
        "additionalProperties": {
          "type": "object",
          "additionalProperties": false
        }
      },
      "DefaultDetailsModel": {
        "type": "object",
        "properties": {
          "reason": {
            "type": "string",
            "description": "Gets or sets the reason, put concisely, for the default",
            "nullable": true
          },
          "reasonDetails": {
            "type": "string",
            "description": "Gets or sets a more detailed account of the reason for default",
            "nullable": true
          },
          "dateDefaulted": {
            "type": "string",
            "description": "Gets or sets the date on which default occurred",
            "format": "date-time"
          },
          "currentAmountAtTimeOfDefault": {
            "type": "number",
            "description": "Gets or sets the loan's Current Amount at the time of default",
            "format": "double"
          }
        },
        "additionalProperties": false,
        "description": "A model representing an instance of loan default, the failure to repay debt associated with a given loan"
      },
      "LeadDetailsModel": {
        "type": "object",
        "properties": {
          "countryISOCode": {
            "type": "string",
            "description": "Gets or sets the registered country iso code of the borrower.",
            "nullable": true
          },
          "email": {
            "type": "string",
            "description": "Gets or sets the registered email of the borrower.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "A model detailing a given loan's lead details."
      },
      "EarlyRenewalDetailsModel": {
        "type": "object",
        "properties": {
          "oldLoanId": {
            "type": "string",
            "description": "Gets or sets the Loan ID of the loan which was renewed",
            "format": "uuid"
          },
          "oldLoanNumber": {
            "type": "integer",
            "description": "Gets or sets the Loan Number of the loan which was renewed",
            "format": "int32"
          },
          "isOldLoanRepaid": {
            "type": "boolean",
            "description": "Gets or sets a value indicating whether the loan which was renewed has been fully repaid"
          },
          "newLoanId": {
            "type": "string",
            "description": "Gets or sets the Loan ID of the Early Remewal loan created",
            "format": "uuid"
          },
          "newLoanNumber": {
            "type": "integer",
            "description": "Gets or sets the Loan Number of the Early Remewal loan created",
            "format": "int32"
          }
        },
        "additionalProperties": false,
        "description": "A model detailing an instance of Early Renewal"
      },
      "LoanFundingPaymentModel": {
        "type": "object",
        "properties": {
          "paymentDate": {
            "type": "string",
            "description": "Gets or sets the Payment Date",
            "format": "date-time"
          },
          "paymentAmount": {
            "type": "number",
            "description": "Gets or sets the Payment Amount",
            "format": "double"
          }
        },
        "additionalProperties": false,
        "description": "A model characterising a given funding payment"
      },
      "LoanFundingDetailsModel": {
        "type": "object",
        "properties": {
          "fundingAmount": {
            "type": "number",
            "description": "Gets or sets the Funding Amount, equal to the Amount Funded when the loan is fully funded",
            "format": "double"
          },
          "fundingDate": {
            "type": "string",
            "description": "Gets or sets the date on which the loan became fully funded",
            "format": "date-time"
          },
          "fundingPayments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LoanFundingPaymentModel"
            },
            "description": "Gets or sets a collection of Funding Payments",
            "nullable": true
          },
          "amountFunded": {
            "type": "number",
            "description": "Gets or sets the Amount Funded",
            "format": "double"
          }
        },
        "additionalProperties": false,
        "description": "A model detailing a given loan's funding"
      },
      "LoanWriteOffDetailsModel": {
        "type": "object",
        "properties": {
          "paymentDate": {
            "type": "string",
            "description": "Gets or sets the Payment Date",
            "format": "date-time"
          },
          "paymentAmount": {
            "type": "number",
            "description": "Gets or sets the Payment Amount",
            "format": "double"
          }
        },
        "additionalProperties": false,
        "description": "A model detailing the write-off of a given loan, if applicable"
      },
      "ThirdPartyReferenceModel": {
        "type": "object",
        "properties": {
          "thirdPartyId": {
            "type": "string",
            "description": "Gets or sets the third party's unique identifier",
            "format": "uuid"
          },
          "thirdPartyReference": {
            "type": "string",
            "description": "Gets or sets the reference provided by the third party",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "A model detailing any references provided by a third party for a given loan"
      },
      "DocumentMetadataModel": {
        "type": "object",
        "properties": {
          "documentId": {
            "type": "string",
            "description": "Gets or sets the document's unique identifier",
            "format": "uuid"
          },
          "documentName": {
            "type": "string",
            "description": "Gets or sets the Document Name",
            "nullable": true
          },
          "documentType": {
            "type": "string",
            "description": "Gets or sets the Document Type - \"Loan Agreement\" or \"Transfer Agreement\"",
            "nullable": true
          },
          "dateUploaded": {
            "type": "string",
            "description": "Gets or sets the date on which the document was uploaded",
            "format": "date-time"
          }
        },
        "additionalProperties": false,
        "description": "A model characterising a given document"
      },
      "YLAdvanceLoanDocument": {
        "type": "object",
        "properties": {
          "document": {
            "$ref": "#/components/schemas/DocumentMetadataModel"
          },
          "documentType": {
            "type": "string",
            "description": "Gets or sets the document type",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "LoanModelExtended": {
        "type": "object",
        "properties": {
          "repaymentMethod": {
            "type": "string",
            "description": "Gets or sets the loan's repayment method.",
            "nullable": true
          },
          "repaymentFrequency": {
            "type": "string",
            "description": "Gets or sets the loan's repayment frequency - can be null when repayment method not Direct Debit or VRP.",
            "nullable": true
          },
          "expectedRepayment": {
            "type": "number",
            "description": "Gets or sets the loan's expected repayment amount - return 0 when frequency null.",
            "format": "double"
          },
          "productType": {
            "type": "string",
            "description": "Gets or sets the product type.",
            "nullable": true
          },
          "autoRepaymentSweep": {
            "type": "boolean",
            "description": "Gets or sets a value indicating whether an Auto Repayment Sweep is to be used - this feature automatically directs a chosen proportion, the Sweep, of transaction income towards repaying the loan."
          },
          "borrowerId": {
            "type": "string",
            "description": "Gets or sets the Borrower ID.",
            "format": "uuid"
          },
          "borrowerName": {
            "type": "string",
            "description": "Gets or sets the Borrower Name.",
            "nullable": true
          },
          "currencyISOCode": {
            "type": "string",
            "description": "Gets or sets the Currency ISO Code.",
            "nullable": true
          },
          "currentAmount": {
            "type": "number",
            "description": "Gets or sets the Current Amount, the amount yet to be repaid.",
            "format": "double"
          },
          "currentServiceChargeRate": {
            "type": "number",
            "description": "(DEPRECATED).",
            "format": "double"
          },
          "defaultDetails": {
            "$ref": "#/components/schemas/DefaultDetailsModel"
          },
          "discount": {
            "type": "number",
            "description": "Gets or sets the loan's discount rate.",
            "format": "double"
          },
          "id": {
            "type": "string",
            "description": "Gets or sets the loan's unique identifier.",
            "format": "uuid"
          },
          "approvalDate": {
            "type": "string",
            "description": "(DEPRECATED).",
            "format": "date-time"
          },
          "maturityDate": {
            "type": "string",
            "description": "Gets or sets the date on which the loan is due to mature, and by which it should be fully repaid.",
            "format": "date-time"
          },
          "originalAmount": {
            "type": "number",
            "description": "Gets or sets the Original Amount, the total amount due to be repaid on maturity.",
            "format": "double"
          },
          "originalServiceChargeRate": {
            "type": "number",
            "description": "(DEPRECATED).",
            "format": "double"
          },
          "projectedRepaymentDate": {
            "type": "string",
            "description": "Gets or sets the Projected Repayment Date.",
            "format": "date-time"
          },
          "securityAndGuarantees": {
            "type": "boolean",
            "description": "(DEPRECATED)."
          },
          "loanType": {
            "type": "string",
            "description": "Gets or sets the Loan Type - \"Initial\", \"Early Renewal\" or \"Renewal\".",
            "nullable": true
          },
          "partnerLoanType": {
            "type": "string",
            "description": "Gets or sets the Partner Loan Type - \"Initial\", \"Early Renewal\" or \"Renewal\".",
            "nullable": true
          },
          "status": {
            "type": "string",
            "description": "Gets or sets the loan's Status - \"Defaulted\", \"Discounted Settlement\", \"Funded\", \"Funded (Pending Settlement)\", \"Partially Funded\", \"Repaid\", \"Requested Funding\", \"Unfunded\", \"Written Off\".",
            "nullable": true
          },
          "sweep": {
            "type": "number",
            "description": "Gets or sets the Sweep, the decimal out of 100 representing the proportion of transaction income to be used to repay the loan.",
            "format": "double"
          },
          "loanNumber": {
            "type": "integer",
            "description": "Gets or sets the Loan Number, an ordinal value indicating which of a customer's loans is here detailed.",
            "format": "int32"
          },
          "creditRating": {
            "type": "string",
            "description": "Gets or sets the Credit Rating.",
            "nullable": true
          },
          "lead": {
            "$ref": "#/components/schemas/LeadDetailsModel"
          },
          "earlyRenewalDetails": {
            "$ref": "#/components/schemas/EarlyRenewalDetailsModel"
          },
          "fundingDetails": {
            "$ref": "#/components/schemas/LoanFundingDetailsModel"
          },
          "writeOffDetails": {
            "$ref": "#/components/schemas/LoanWriteOffDetailsModel"
          },
          "thirdPartyReferences": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ThirdPartyReferenceModel"
            },
            "description": "Gets or sets the loan's Third Party References YL.Web.Api.ThirdParty.Loan.V2.Models.ThirdPartyReferenceModel.",
            "nullable": true
          },
          "documents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/YLAdvanceLoanDocument"
            },
            "description": "Gets or sets the all loan document metadata and document type YL.Web.Api.ThirdParty.Loan.V2.Models.YLAdvanceLoanDocument.",
            "nullable": true
          },
          "contractType": {
            "type": "string",
            "description": "Gets or sets the agreement contract type (\"RPA\" / \"LA\") if available.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "A model representing the details of an individual loan with extended information."
      }
    },
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://youlend-stag.eu.auth0.com/oauth/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "security": [
    {
      "oauth2": []
    }
  ]
}
```