curl --request POST \
--url https://api.sandbox.lead.bank/v2/user_accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"requested_features": [
"deposit"
],
"product_config_id": "product_config_xyz123",
"entities": {
"account_holders": [
"entity_consumer_123"
]
},
"product_name": "Everyday Checking",
"metadata": {},
"documents": []
}
'{
"id": "user_account_xyz123",
"status": "active",
"status_reason": "client_closed",
"features": [
"deposit"
],
"entities": {
"account_holder_type": "consumer"
},
"details": {
"underwriting": {
"is_secured": true,
"is_mla": true,
"underwriting_grade": "<string>",
"currency_code": "USD",
"available_credit": 123,
"limit": 123,
"max_limit": 123,
"scra": {
"start_date": "2023-12-25",
"end_date": "2023-12-25"
},
"report": {
"pulled_at": "2023-11-07T05:31:56Z",
"source": "equifax",
"score": 575,
"non_score_value": "unestablished"
}
},
"adverse_action_notice": {
"delivered_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"delivery_method": "email"
}
},
"product_name": "<string>",
"documents": [
{
"file_id": "file_7RwQ2mK9pL4xT1vN8jS5",
"timestamp": "2026-09-14T14:20:11Z",
"version": "v2"
}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"application_id": "application_xyz123",
"legacy_documents": [
{
"document_id": "loan_agreement_01_2026.pdf",
"type": "aan",
"displayed_at": "2023-11-07T05:31:56Z",
"consented_at": "2023-11-07T05:31:56Z",
"version": "v1"
}
],
"client_account_id": "<string>",
"balance_sheet_model": "held_for_investment",
"product_config_id": "product_config_xyz123",
"closed_at": "2023-11-07T05:31:56Z"
}{
"code": "idempotency_key_missing",
"message": "This endpoint requires an Idempotency-Key header. Add one and resend the request."
}{
"code": "token_invalid",
"message": "The bearer token is missing, expired, malformed, or invalid."
}{
"code": "idempotency_key_in_use",
"message": "A concurrent request using this Idempotency-Key is still in flight."
}{
"code": "content_too_large",
"message": "The request is over a size limit for this endpoint. Make it smaller and resend it.",
"errors": [
{
"code": "body_too_large",
"message": "metadata is over this endpoint's size limit.",
"parameters": [
"metadata"
]
}
]
}{
"code": "parameters_invalid",
"message": "One or more parameters are invalid.",
"errors": [
{
"code": "dependent_parameter_required",
"message": "balance_sheet_model is required when requested_features includes a credit feature.",
"parameters": [
"balance_sheet_model"
]
},
{
"code": "parameter_bound_exceeded",
"message": "details.underwriting.limit (10000000) cannot exceed details.underwriting.max_limit (5000000).",
"parameters": [
"details.underwriting.limit"
]
}
]
}{
"code": "rate_limit_exceeded",
"message": "You have exceeded the rate limit for this endpoint. Retry with backoff."
}{
"code": "internal_server_error",
"message": "Something went wrong on our end. Contact Lead with the Request-Id if this persists."
}{
"code": "service_unavailable",
"message": "The service is temporarily unavailable. Retry after the indicated delay."
}{
"code": "gateway_timeout",
"message": "An upstream system timed out. Retry with backoff."
}Create a User Account
Create a User Account.
curl --request POST \
--url https://api.sandbox.lead.bank/v2/user_accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"requested_features": [
"deposit"
],
"product_config_id": "product_config_xyz123",
"entities": {
"account_holders": [
"entity_consumer_123"
]
},
"product_name": "Everyday Checking",
"metadata": {},
"documents": []
}
'{
"id": "user_account_xyz123",
"status": "active",
"status_reason": "client_closed",
"features": [
"deposit"
],
"entities": {
"account_holder_type": "consumer"
},
"details": {
"underwriting": {
"is_secured": true,
"is_mla": true,
"underwriting_grade": "<string>",
"currency_code": "USD",
"available_credit": 123,
"limit": 123,
"max_limit": 123,
"scra": {
"start_date": "2023-12-25",
"end_date": "2023-12-25"
},
"report": {
"pulled_at": "2023-11-07T05:31:56Z",
"source": "equifax",
"score": 575,
"non_score_value": "unestablished"
}
},
"adverse_action_notice": {
"delivered_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"delivery_method": "email"
}
},
"product_name": "<string>",
"documents": [
{
"file_id": "file_7RwQ2mK9pL4xT1vN8jS5",
"timestamp": "2026-09-14T14:20:11Z",
"version": "v2"
}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"application_id": "application_xyz123",
"legacy_documents": [
{
"document_id": "loan_agreement_01_2026.pdf",
"type": "aan",
"displayed_at": "2023-11-07T05:31:56Z",
"consented_at": "2023-11-07T05:31:56Z",
"version": "v1"
}
],
"client_account_id": "<string>",
"balance_sheet_model": "held_for_investment",
"product_config_id": "product_config_xyz123",
"closed_at": "2023-11-07T05:31:56Z"
}{
"code": "idempotency_key_missing",
"message": "This endpoint requires an Idempotency-Key header. Add one and resend the request."
}{
"code": "token_invalid",
"message": "The bearer token is missing, expired, malformed, or invalid."
}{
"code": "idempotency_key_in_use",
"message": "A concurrent request using this Idempotency-Key is still in flight."
}{
"code": "content_too_large",
"message": "The request is over a size limit for this endpoint. Make it smaller and resend it.",
"errors": [
{
"code": "body_too_large",
"message": "metadata is over this endpoint's size limit.",
"parameters": [
"metadata"
]
}
]
}{
"code": "parameters_invalid",
"message": "One or more parameters are invalid.",
"errors": [
{
"code": "dependent_parameter_required",
"message": "balance_sheet_model is required when requested_features includes a credit feature.",
"parameters": [
"balance_sheet_model"
]
},
{
"code": "parameter_bound_exceeded",
"message": "details.underwriting.limit (10000000) cannot exceed details.underwriting.max_limit (5000000).",
"parameters": [
"details.underwriting.limit"
]
}
]
}{
"code": "rate_limit_exceeded",
"message": "You have exceeded the rate limit for this endpoint. Retry with backoff."
}{
"code": "internal_server_error",
"message": "Something went wrong on our end. Contact Lead with the Request-Id if this persists."
}{
"code": "service_unavailable",
"message": "The service is temporarily unavailable. Retry after the indicated delay."
}{
"code": "gateway_timeout",
"message": "An upstream system timed out. Retry with backoff."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A unique key for this request, up to 255 characters. Retrying with the same key and body returns the original response without creating a second user account. See Idempotency.
255Body
Request body for creating a new user account
Entity relationships for the user account (POST request only). Maximum 20 entities per relationship type. Cannot mix individual and business/sole_prop entities in account_holders. Authorized signers required for business/sole_prop account holders.
Show child attributes
Show child attributes
Partner's name for their product
Identifies the product configuration set up for your program. Provided to you by your Lead Technical Account Manager. Cannot be changed once set.
^product_config_\w+$"product_config_xyz123"
Compliance documents linked to the user account. Each entry references a
file uploaded with the Files API.
Send [] when there are none to link yet.
Show child attributes
Show child attributes
Unique identifier for the application. Prefixed with application_.
^application_\w+$"application_xyz123"
Additional details for the user account
Show child attributes
Show child attributes
A set of key-value pairs that can be used to store additional information related to this object.
Show child attributes
Show child attributes
Response
User account created successfully.
A user account object
The ID of the User Account object.
^user_account_\w+$"user_account_xyz123"
Current state of the user account
active, inactive, closed Machine-readable reason for the current status
client_closed, entity_closed, frozen, dormant, active, paid_off, charged_off, canceled, other Features granted to the user account.
A feature of the user account
deposit, credit_with_underwriting, credit_without_underwriting Entity relationships associated with the user account (response only)
Show child attributes
Show child attributes
Core details of the user account
Show child attributes
Show child attributes
Partner's name for their product
Compliance documents linked to the user account. Each entry references a file uploaded with the Files API.
Show child attributes
Show child attributes
A set of key-value pairs that can be used to store additional information related to this object.
Show child attributes
Show child attributes
Creation timestamp
Last update timestamp
Unique identifier for the application. Prefixed with application_.
^application_\w+$"application_xyz123"
Document entries created on v0 User Accounts, returned exactly as sent. Read only: ignored if included on a POST or PATCH.
Show child attributes
Show child attributes
The identifier you assigned in an Account file. Present only on user
accounts created through file upload. Omitted on user accounts created
through the API, which are identified only by id.
How Lead carries the user account's credit on its balance sheet.
held_for_investment, held_for_sale The id of the product configuration the user account was created under.
null only on user accounts created before product config ids existed.
^product_config_\w+$"product_config_xyz123"
Timestamp when the user account was closed. Updated by /close endpoint.
Was this page helpful?

