Getting started
Transactions
List provider mail
curl --request GET \
--url https://api.getlemma.com/v0/providers/{provider_id}/mail \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "inbound_mail_item_Kv7nWp3hTx9cBd5m",
"provider_id": "entity_k7mXp2vR9nTfBw4s",
"file_id": "file_Xt7nRv3hBw9pKm4s",
"amount": 372500,
"checks": [
{
"id": "check_deposit_Tm6bXn9hRw3pFk7c",
"amount": 100000,
"transaction_id": "transaction_Ab5cDx3nKv8bTh2d",
"status": "submitted",
"hold": {
"status": "held",
"automatically_releases_at": "2026-03-19T14:00:00Z",
"released_at": null
},
"micr": {
"routing_number": "021000021",
"account_number": "9876543210",
"auxiliary_on_us": null,
"serial_number": "00012345"
}
},
{
"id": "check_deposit_Jd4xVs8mBn2wYh5t",
"amount": 2000,
"transaction_id": null,
"status": "rejected",
"hold": null,
"micr": null
}
],
"received_at": "2026-03-14T14:00:00Z"
},
{
"id": "inbound_mail_item_Rs4bFj8wNm2yHt6x",
"provider_id": "entity_k7mXp2vR9nTfBw4s",
"file_id": "file_Hd5cWm8nTx2vFk7b",
"amount": 0,
"checks": [],
"received_at": "2026-03-13T10:45:00Z"
}
]
}
Lockbox
List provider mail
Retrieve all lockbox mail for a provider.
GET
/
v0
/
providers
/
{provider_id}
/
mail
List provider mail
curl --request GET \
--url https://api.getlemma.com/v0/providers/{provider_id}/mail \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "inbound_mail_item_Kv7nWp3hTx9cBd5m",
"provider_id": "entity_k7mXp2vR9nTfBw4s",
"file_id": "file_Xt7nRv3hBw9pKm4s",
"amount": 372500,
"checks": [
{
"id": "check_deposit_Tm6bXn9hRw3pFk7c",
"amount": 100000,
"transaction_id": "transaction_Ab5cDx3nKv8bTh2d",
"status": "submitted",
"hold": {
"status": "held",
"automatically_releases_at": "2026-03-19T14:00:00Z",
"released_at": null
},
"micr": {
"routing_number": "021000021",
"account_number": "9876543210",
"auxiliary_on_us": null,
"serial_number": "00012345"
}
},
{
"id": "check_deposit_Jd4xVs8mBn2wYh5t",
"amount": 2000,
"transaction_id": null,
"status": "rejected",
"hold": null,
"micr": null
}
],
"received_at": "2026-03-14T14:00:00Z"
},
{
"id": "inbound_mail_item_Rs4bFj8wNm2yHt6x",
"provider_id": "entity_k7mXp2vR9nTfBw4s",
"file_id": "file_Hd5cWm8nTx2vFk7b",
"amount": 0,
"checks": [],
"received_at": "2026-03-13T10:45:00Z"
}
]
}
Returns a list of all mail items received at the provider’s lockbox. Each item includes aDocumentation Index
Fetch the complete documentation index at: https://docs.getlemma.com/llms.txt
Use this file to discover all available pages before exploring further.
file_id for the scanned PDF and an amount representing the total value of any checks found in that piece of mail. If the mail contained checks, they are listed in the checks array.
Path parameters
The ID of the provider. You can find provider IDs using the List
providers endpoint.
Query parameters
Response
The list of mail objects.
Show Mail object
Show Mail object
Unique identifier for the lockbox mail item.
The ID of the provider whose lockbox received this mail.
The ID of the scanned PDF. Use the Get PDF
endpoint to retrieve a temporary download URL.
The total value of all checks in this piece of mail, in cents. Zero if no
checks were found.
The checks found in this piece of mail. Empty array if no checks were
found.
Show Check object
Show Check object
Unique identifier for the check, prefixed with
check_deposit_.The amount of the check in cents.
The ID for the transaction created by the check deposit. Null if the
check is pending manual intervention.
The processing status of the check. One of
pending, submitted, returned, or rejected.Pending means Lemma has not attempted to deposit the check yet.Submitted means the check has been submitted for deposit. There will be a hold on the funds for a few days.Returned checks are unlikely to happen to healthcare providers receiving funds from payers. Nevertheless, here are a few common reasons checks are returned:- Insufficient funds
- Stop payment instructions
- The check was drawn from a closed bank account
- The check was not authorized
Fund hold details. Present when deposited funds are held before becoming available. Null if there is no hold.
Fields read from the check’s MICR line. Null when we have not submitted the check for deposit.
Show MICR object
Show MICR object
The routing number printed on the check.
The account number printed on the check.
An additional identifier from the MICR line. Business checks typically encode the check number here rather than in
serial_number.The check number. For business checks, this may be null — look at
auxiliary_on_us instead.{
"data": [
{
"id": "inbound_mail_item_Kv7nWp3hTx9cBd5m",
"provider_id": "entity_k7mXp2vR9nTfBw4s",
"file_id": "file_Xt7nRv3hBw9pKm4s",
"amount": 372500,
"checks": [
{
"id": "check_deposit_Tm6bXn9hRw3pFk7c",
"amount": 100000,
"transaction_id": "transaction_Ab5cDx3nKv8bTh2d",
"status": "submitted",
"hold": {
"status": "held",
"automatically_releases_at": "2026-03-19T14:00:00Z",
"released_at": null
},
"micr": {
"routing_number": "021000021",
"account_number": "9876543210",
"auxiliary_on_us": null,
"serial_number": "00012345"
}
},
{
"id": "check_deposit_Jd4xVs8mBn2wYh5t",
"amount": 2000,
"transaction_id": null,
"status": "rejected",
"hold": null,
"micr": null
}
],
"received_at": "2026-03-14T14:00:00Z"
},
{
"id": "inbound_mail_item_Rs4bFj8wNm2yHt6x",
"provider_id": "entity_k7mXp2vR9nTfBw4s",
"file_id": "file_Hd5cWm8nTx2vFk7b",
"amount": 0,
"checks": [],
"received_at": "2026-03-13T10:45:00Z"
}
]
}
⌘I