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

# List settlement details with an account opening letter.

For partners which perform the sweep, this endpoint needs to be called because the virtualIban/ secondaryVirtualIban describe the account to which the sweep needs to be sent in order to repay the funding.

virtualIban and secondaryVirtualIban have the same destination, the difference is that virtualIban is typically a DK IBAN and and secondaryVirtualIban is typically GB.

# 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}/documents/accountopeningletter": {
      "get": {
        "tags": [
          "GET Details"
        ],
        "summary": "List settlement details with an account opening letter.",
        "parameters": [
          {
            "name": "leadId",
            "in": "path",
            "description": "The lead id.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          },
          {
            "name": "filterByThirdPartyCustomerId",
            "in": "query",
            "description": "<i>Optional</i> - Only show settlement accounts where the third party customer id matches the lead.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "api-version",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SettlementAccountDetails"
                  }
                }
              },
              "application/xml": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SettlementAccountDetails"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "DocumentModel": {
        "type": "object",
        "properties": {
          "documentId": {
            "type": "string",
            "description": "Gets or sets the document id, a GUID.",
            "format": "uuid"
          },
          "document": {
            "type": "string",
            "description": "Gets or sets the docment content (a byte[]).",
            "format": "byte",
            "nullable": true
          },
          "documentName": {
            "type": "string",
            "description": "Gets or sets the document name.",
            "nullable": true
          },
          "documentType": {
            "type": "string",
            "description": "Gets or sets the document type.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Model containing the metadata and byte array for a document."
      },
      "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": {}
      },
      "SettlementAccountDetails": {
        "type": "object",
        "properties": {
          "iban": {
            "type": "string",
            "description": "Gets or sets the account iban.",
            "nullable": true
          },
          "virtualIban": {
            "type": "string",
            "description": "Gets or sets the account virtual iban.",
            "nullable": true
          },
          "secondaryVirtualIban": {
            "type": "string",
            "description": "Gets or sets the account secondary virtual iban.",
            "nullable": true
          },
          "accountName": {
            "type": "string",
            "description": "Gets or sets the name of the account.",
            "nullable": true
          },
          "currencyISOCode": {
            "type": "string",
            "description": "Gets or sets the currency of the account.",
            "nullable": true
          },
          "accountOpeningLetter": {
            "$ref": "#/components/schemas/DocumentModel"
          },
          "domesticAccountNumber": {
            "type": "string",
            "description": "Gets or sets the account number. In the case of US accounts, this holds the bank account number.",
            "nullable": true
          },
          "domesticSortCode": {
            "type": "string",
            "description": "Gets or sets the sort code. In the case of US accounts, this holds the routing number.",
            "nullable": true
          },
          "partner": {
            "type": "string",
            "description": "Gets or sets the partner name.",
            "nullable": true
          },
          "swift": {
            "type": "string",
            "description": "Gets or sets the swift code.",
            "nullable": true
          },
          "thirdPartyCustomerId": {
            "type": "string",
            "description": "Gets or sets the third party customer id.",
            "nullable": true
          },
          "thirdPartyCustomerIdOnAccount": {
            "type": "string",
            "description": "Gets or sets the third party customer id on the account.",
            "nullable": true
          },
          "secondarySwiftCode": {
            "type": "string",
            "description": "Gets or sets the secondary swift code.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Model containing the details for a settlement account."
      }
    },
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://youlend-stag.eu.auth0.com/oauth/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "security": [
    {
      "oauth2": []
    }
  ],
  "tags": [
    {
      "name": "GET Details"
    }
  ]
}
```