{ "opencollection": "1.0.0", "info": { "name": "LendKey E-Sign API (via Kong Gateway) Application Contracts API", "version": "0.1" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Application Contracts", "type": "folder" }, "items": [ { "info": { "name": "Get Application Contracts", "type": "http" }, "http": { "method": "GET", "url": "https://api.lendkey.com/esign/applications", "params": [ { "name": "lender_uuid", "value": "550e8400-e29b-41d4-a716-446655440000", "type": "query", "description": "Lender UUID" }, { "name": "program_id", "value": "1234567890", "type": "query", "description": "Program identifier" } ] }, "docs": "Retrieves application envelope summaries for a specific lender and program.\n\n**Kong Route:** `/applications`\n**Backend:** `/applications`\n" }, { "info": { "name": "Create New Application Contract", "type": "http" }, "http": { "method": "POST", "url": "https://api.lendkey.com/esign/applications", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new e-signature contract envelope in DocuSign for a loan application.\nThe contract is created from a lender-specific template and includes all applicant\ninformation, property details, and loan terms.\n\n**Kong Route:** `/applications`\n**Backend:** `/applications`\n" }, { "info": { "name": "Get Application Statuses", "type": "http" }, "http": { "method": "GET", "url": "https://api.lendkey.com/esign/applications/:application_uuid/statuses", "params": [ { "name": "application_uuid", "value": "550e8400-e29b-41d4-a716-446655440000", "type": "path", "description": "Application UUID" } ] }, "docs": "Retrieves the status history of a specific application envelope.\n\n**Kong Route:** `/applications/{application_uuid}/statuses`\n**Backend:** `/applications/{application_uuid}/statuses`\n" }, { "info": { "name": "Get Signer Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.lendkey.com/esign/applications/:application_uuid/signers/:customer_uuid", "params": [ { "name": "application_uuid", "value": "550e8400-e29b-41d4-a716-446655440000", "type": "path", "description": "Application UUID" }, { "name": "customer_uuid", "value": "770e8400-e29b-41d4-a716-446655440000", "type": "path", "description": "Customer UUID" } ] }, "docs": "Retrieves the details of a specific signer for a completed application envelope.\nReturns signer information and form field data collected from the signer.\n\n**Note:** Only available after envelope is completed.\n\n**Kong Route:** `/applications/{application_uuid}/signers/{customer_uuid}`\n**Backend:** `/applications/{application_uuid}/signers/{customer_uuid}`\n" }, { "info": { "name": "Generate Embedded Signing Link", "type": "http" }, "http": { "method": "GET", "url": "https://api.lendkey.com/esign/applications/:application_uuid/signers/:customer_uuid/embedded-link", "params": [ { "name": "application_uuid", "value": "550e8400-e29b-41d4-a716-446655440000", "type": "path", "description": "Application UUID" }, { "name": "customer_uuid", "value": "770e8400-e29b-41d4-a716-446655440000", "type": "path", "description": "Customer UUID" }, { "name": "return_url", "value": "https://yourapp.com/signing-complete", "type": "query", "description": "URL where signer will be redirected after completing or canceling signing" } ] }, "docs": "Generates an embedded signing URL for a signer to sign documents directly within an iframe.\nThe signing URL is time-limited and should be used immediately after generation.\n\n**Kong Route:** `/applications/{application_uuid}/signers/{customer_uuid}/embedded-link`\n**Backend:** `/applications/{application_uuid}/signers/{customer_uuid}/embedded-link`\n" } ] } ], "bundled": true }