Skip to navigation
APIBorrowers

Complete borrower intake

Completes an intake borrower’s profile: sets its business name and clears is_intake, moving it from the intake list into the borrower list. The body carries the name and nothing else; set every other profile field with the update operation. Answers 409 for a borrower that is already completed.

Requires the borrowers:write scope. Rate limit: 200 requests per minute per key (the api lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Path parameters

borrower_idstringRequired

Headers

Idempotency-KeystringOptional<=255 characters

Idempotency token. Retries that reuse the key within 24h replay the original response. Up to 255 characters; a UUID is typical. See Idempotency.

SpreadSpace-VersionstringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.

Request

This endpoint expects an object.
namestringRequired<=256 characters

The borrower’s real business name. Required and non-blank; supplying it on this endpoint is the only way a borrower leaves intake.

Response headers

X-Request-IDstringOptional
Correlation ID for this request. Quote it in support tickets.
Idempotency-Replayboolean

Set to true when the response is replayed from the idempotency cache for a request that re-presented an Idempotency-Key it had already used. Absent on the original (winner) response. A replay repeats the original status and body. When the original could not be stored (an unhandled server fault, or a body over the 1 MiB replay cap) the replay is an error envelope that says so; the operation is never re-run under the same key.

SpreadSpace-VersionstringOptional

The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-10-07.

RateLimit-Limitinteger

Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

OK
borrower_idstring

The borrower’s id, 24 lowercase hex characters. Pass it as borrower_id on every borrower route.

namestring
The borrower's legal name, at most 200 characters.
created_atdatetime
When the borrower was created, RFC 3339.
updated_atdatetime
When the borrower's record last changed, RFC 3339.
statusenum

The borrower’s standing: good_standing, pending_audit or flagged. A new borrower starts in good_standing.

Allowed values:
is_intakeboolean

True for a borrower auto-provisioned by intake whose profile has not been completed. Present on every borrower payload.

dba_namestring or nullOptional
The trade name the borrower does business under when it differs from the legal name, at most 200 characters. Null when none was entered.
legal_entity_typestring or nullOptional

The borrower’s legal form as entered, for example LLC, at most 100 characters. Null when none was entered.

tax_filing_statusstring or nullOptional
How the borrower files its federal return, as entered, for example as a partnership or an S corporation, at most 100 characters. Null when none was entered.
tin_last4string or nullOptional
The last four digits of the borrower's tax identification number, exactly four digits. Null when none was entered.
tin_typestring or nullOptional

Which identifier tin_last4 ends, as entered, for example EIN or SSN, at most 10 characters. Null when none was entered.

citystring or nullOptional
The city of the borrower's address, at most 100 characters. Null when none was entered.
statestring or nullOptional

The two-letter state or territory code of the borrower’s address. Null when none was entered.

zip_codestring or nullOptional
The postal code of the borrower's address, at most 10 characters. Null when none was entered.
state_of_formationstring or nullOptional

The two-letter code of the state the borrower was formed in. Null when none was entered.

industrystring or nullOptional
The borrower's industry as entered, at most 100 characters. Null when none was entered.
sub_industrystring or nullOptional

A narrower line of business within industry, as entered, at most 100 characters. Null when none was entered.

naics_codestring or nullOptional

The borrower’s NAICS code, up to six digits: the one entered, or the one its filed returns state. Null until one is known.

date_establisheddate or nullOptional
The date the business was established, as entered. Null when none was entered.
fiscal_year_end_monthinteger or nullOptional
The month the borrower's fiscal year ends, 1 through 12. Null when none was entered.
number_of_principalsinteger or nullOptional
How many principals the business has, as entered, 0 through 10000. Null when none was entered.
filing_typestring or nullOptional

The return type the borrower files, on the single-borrower read. Null on the list and on the create, update and complete-intake responses.

last_activity_atdatetime or nullOptional
When activity on the borrower was last recorded, RFC 3339. Null when none has been recorded.
loan_countinteger or nullOptional

How many loans the borrower has, on the list and the single-borrower read. Null on the create, update and complete-intake responses, and where the caller may not see the borrower’s detail.

notesstring or nullOptional

Free-text notes on the borrower, at most 2000 characters. Null when none were entered, and null on a payload the caller may not read in full.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error