# Client intake applications

Complete a business's intake application, check what is missing, and submit it.

Base URL: https://api.levr.ai/v1

Authentication: Bearer — Portal API key

[REST guide](https://docs.levr.ai/rest-api.md) · [OpenAPI specification](https://docs.levr.ai/generated/openapi.json)

OpenAPI defines exact REST schemas. Each record’s Application Contract defines its current questions and accepted answers.

## Complete the application

Each application has its own questions and document requirements. Start with the application linked to the business or deal you are working on. Your API key needs access to that application resource; business or deal access alone does not grant it.

1. Read the application and fetch its `contract_url`. The returned Application Contract defines its current questions, accepted values, required fields, repeated entries, and operation URLs.
2. Read the answers. Use the contract's `block_key` and `field_key` for updates, with the answers response's ETag in `If-Match`.
3. Complete repeated entries and attach documents using the operations described below. You can also use Autofill to prepare suggestions.
4. Read submission readiness and resolve the reported issues. Review the current answers before submitting.
5. Submit using the application's lifecycle ETag and the reviewed `expected_answers_revision`. Read the application afterward to confirm the result.

The application ETag protects lifecycle changes; the answers ETag protects answers. They are separate revisions. A submission receipt confirms the recorded submission, not lender acceptance, approval, or funding.

Fetch the contract again when its `contract_version` changes. A newly published form does not establish the questions in an existing application.

## Add repeated entries

The contract's `repeatable_groups` describe the allowed rows and their question keys. Use `operations.repeatable_items_url` to list or create rows. Use the returned `item_id` for updates, deletes, and answers inside that row. A row's position is not its ID.

These writes require the latest answers ETag and an `Idempotency-Key`. If answers change, read them again before retrying.

## Attach documents

File bytes never belong in JSON. Request an upload through `operations.file_uploads_url` with the file question's `block_key` and, for a repeated entry, its `item_id`.

The response gives an expiring `upload_url`, exact multipart field name, and size limit. Upload one `file` part with the required `If-Match` and `Idempotency-Key` headers. Read `operations.files_url` afterward to confirm the file and obtain download URLs. Delete files using their returned `file_id`.

Resolve relative download URLs against the API origin and use the documented authentication. Read fresh metadata when a download URL expires.

## Use Autofill to prepare answers

Autofill turns email text and documents into suggestions. It does not save application answers until you accept suggestions.

1. Read Autofill preparation, add email text, and optionally upload supporting files. Use the latest preparation ETag after each change.
2. Start a run with `expected_preparation_revision` set to the latest preparation revision. Keep its URL so you can resume monitoring.
3. Check the run while it is `pending` or `running`. When it settles, read its suggestions and any warnings or failures.
4. Review the proposed values, sources, and concerns. Accept only the suggestions you intend to save, using the latest answers revision.
5. Read the application answers to confirm what was saved.

Preparation’s `files` list shows each supporting document’s name and processing status. Check it after an upload, or if the upload response was lost, before uploading the document again. A document is `pending` while queued, `running` while being read, `success` when ready for Autofill, or `failed` when it needs attention. Read preparation again to check progress; processing updates do not change its revision.

For scalar suggestions, the suggested answer is `proposed_value.field_value`. Compound proposals contain `attributes`; repeated-entry proposals contain `list_items`; file proposals contain file-source metadata. Review the complete proposal, then use the suggestion's acceptance operation to save it. You do not need to reconstruct an answer update from the proposal.

Treat numeric proposal metadata as opaque context. Write answers using the keys and repeated-entry IDs returned by the Application Contract.

Review one pending suggestion's proposed value, evidence, and concerns. Read the current answers, then POST to the Run's suggestions_url plus {suggestion_id}/accept/ with no request body, the answer ETag in If-Match, and a unique Idempotency-Key. Levr checks the answer revision and target drift, applies the proposal, and records acceptance in one transaction. A 412 means the answers changed; reread and review before issuing a new command. A 409 suggestion_conflict means the suggestion is stale, superseded, or already resolved; refresh suggestions and review again. An identical retry must reuse the original precondition and key. Check the returned suggestion is accepted and verify the intended value through the answers read. Use the returned ETag for the next answer mutation. Do not copy proposal metadata into an answer-update request to accept a suggestion.

A settled webhook tells you the run has finished processing. Review and accept its suggestions before submitting the application. Set a polling deadline and keep the run URL so you can check again later. Check warnings and `can_retry` before using the returned `retry_url`.


- [Get a client intake application](https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-application.md): `GET /client-intake-applications/{application_id}/`

- [Retrieve a client intake application contract](https://docs.levr.ai/rest-api-reference/client-intake-applications/retrieve-client-intake-application-contract.md): `GET /client-intake-applications/{application_id}/contract/`

- [List client intake application answers](https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answers.md): `GET /client-intake-applications/{application_id}/answers/`

- [Update client intake application answers](https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-answers.md): `PATCH /client-intake-applications/{application_id}/answers/`

- [List repeatable answer items](https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-repeatable-items.md): `GET /client-intake-applications/{application_id}/answers/repeatable-items/`

- [Create a repeatable answer item](https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-repeatable-item.md): `POST /client-intake-applications/{application_id}/answers/repeatable-items/`

- [Update a repeatable answer item](https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-repeatable-item.md): `PATCH /client-intake-applications/{application_id}/answers/repeatable-items/`

- [Delete a repeatable answer item](https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-repeatable-item.md): `DELETE /client-intake-applications/{application_id}/answers/repeatable-items/`

- [List answer files](https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answer-files.md): `GET /client-intake-applications/{application_id}/answers/files/`

- [Request an answer-file upload](https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-answer-file-upload.md): `POST /client-intake-applications/{application_id}/answers/files/`

- [Upload an answer file](https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-application-answer-file.md): `POST /client-intake-applications/{application_id}/answers/files/{upload_id}/`

- [Delete an answer file](https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-answer-file.md): `DELETE /client-intake-applications/{application_id}/answers/files/`

- [Read prepared client intake autofill evidence](https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-preparation.md): `GET /client-intake-applications/{application_id}/autofill-preparation/`

- [Start client intake autofill](https://docs.levr.ai/rest-api-reference/client-intake-applications/start-client-intake-autofill.md): `POST /client-intake-applications/{application_id}/autofill-runs/`

- [Update client intake autofill preparation](https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-autofill-preparation.md): `PATCH /client-intake-applications/{application_id}/autofill-preparation/`

- [Upload one client intake autofill evidence file](https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-autofill-preparation-file.md): `POST /client-intake-applications/{application_id}/autofill-preparation/files/`

- [Poll client intake autofill](https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-run.md): `GET /client-intake-application-autofill-runs/{run_id}/`

- [List client intake autofill suggestions](https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-autofill-suggestions.md): `GET /client-intake-application-autofill-runs/{run_id}/suggestions/`

- [Accept autofill suggestion](https://docs.levr.ai/rest-api-reference/client-intake-applications/accept-client-intake-autofill-suggestion.md): `POST /client-intake-application-autofill-runs/{run_id}/suggestions/{suggestion_id}/accept/`

- [Retry unresolved client intake autofill work](https://docs.levr.ai/rest-api-reference/client-intake-applications/retry-client-intake-autofill.md): `POST /client-intake-application-autofill-runs/{run_id}/retry/`

- [Share a client intake application with recipients by email](https://docs.levr.ai/rest-api-reference/client-intake-applications/share-client-intake-application.md): `POST /client-intake-applications/{application_id}/share/`

- [Check client intake application submission readiness](https://docs.levr.ai/rest-api-reference/client-intake-applications/check-client-intake-application-submission-readiness.md): `GET /client-intake-applications/{application_id}/submission-readiness/`

- [Submit a client intake application](https://docs.levr.ai/rest-api-reference/client-intake-applications/submit-client-intake-application.md): `POST /client-intake-applications/{application_id}/submit/`