---
updatedAt: 2026-05-19T09:34:46.000Z
agentTools:
  projectIndex: https://developer.eftcorp.com/llms.txt
---

# Opt-In the customer for the loans

Opt-In the customer for the loans

# OpenAPI definition

```json
{
  "servers": [
    {
      "url": "https://eclipse-java-sandbox.ukheshe.rocks",
      "description": "Eclipse sandbox environment"
    },
    {
      "url": "https://ukheshe.live",
      "description": "Eclipse production environment"
    },
    {
      "url": "https://eclipse-java-develop.ukheshe.rocks",
      "description": "Eclipse development environment"
    },
    {
      "url": "https://zw.ukheshe.live",
      "description": "Zim Eclipse production environment"
    }
  ],
  "openapi": "3.1.0",
  "components": {
    "schemas": {
      "EclipseLoanOptIn": {
        "type": "object",
        "properties": {
          "additionalFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LoanAdditionalField"
            }
          },
          "address": {
            "type": "string"
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2022-03-10T12:15:50-04:00"
            ]
          },
          "creditScore": {
            "type": "integer",
            "format": "int32"
          },
          "creditScoreLastVerified": {
            "type": "string",
            "format": "date-time",
            "examples": [
              "2022-03-10T12:15:50-04:00"
            ]
          },
          "email": {
            "type": "string"
          },
          "externalCustomerId": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "identityNumber": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "walletId": {
            "type": "string"
          }
        }
      },
      "LoanAdditionalField": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "NewEclipseLoanOptIn": {
        "type": "object",
        "properties": {
          "additionalFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LoanAdditionalField"
            },
            "description": "Fields that must be completed by the borrower and provided on the POST or PUT to update the loan for processing. Its up to the UI to decide how to lay these out and ask for them as the loans API will require these fields"
          },
          "provider": {
            "type": "string",
            "description": "Loan provider"
          },
          "walletId": {
            "type": "integer",
            "format": "int64",
            "description": "A walletId representing the id of the customer's wallet where the loan amount will be credited or debited when making payments on the loan",
            "exclusiveMinimum": 0
          }
        }
      }
    },
    "securitySchemes": {
      "JWTBearerAuthorisation": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "info": {
    "description": "A RESTful API using JSON as the data transfer model, covering all tenant-facing functionality in the Eclipse payments platform.",
    "title": "Eclipse ReST API",
    "version": "3.0.0"
  },
  "tags": [
    {
      "name": "d) Customer Management",
      "description": "Operations on an individual customer profile including identity management, addresses, documents, wallets, cards, beneficiaries, and KYC ratification."
    }
  ],
  "paths": {
    "/eclipse-conductor/rest/v1/tenants/{tenantId}/customers/{customerId}/loans/opt-in": {
      "post": {
        "summary": "Opt-In the customer for the loans",
        "description": "Opt-In the customer for the loans",
        "tags": [
          "d) Customer Management"
        ],
        "parameters": [
          {
            "name": "tenantId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "customerId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewEclipseLoanOptIn"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EclipseLoanOptIn"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          }
        },
        "security": [
          {
            "JWTBearerAuthorisation": []
          }
        ]
      }
    }
  }
}
```