Skip to navigation
APIBorrowers

Create borrower

Creates a borrower. status is free text (at most 20 characters) and defaults to good_standing.

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.

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<=200 characters
dba_namestring or nullOptional<=200 characters
legal_entity_typestring or nullOptional<=100 characters
tax_filing_statusstring or nullOptional<=100 characters
ein_last4string or nullOptionalformat: "^\d{4}$"<=4 characters
ssn_last4string or nullOptionalformat: "^\d{4}$"<=4 characters
tin_last4string or nullOptionalformat: "^\d{4}$"<=4 characters
tin_typestring or nullOptional<=10 characters
citystring or nullOptional<=100 characters
statestring or nullOptional<=2 characters
zip_codestring or nullOptional<=10 characters
state_of_formationstring or nullOptional<=2 characters
industrystring or nullOptional<=100 characters
sub_industrystring or nullOptional<=100 characters
naics_codestring or nullOptional<=6 characters
date_establisheddate or nullOptional
fiscal_year_end_monthinteger or nullOptional1-12
number_of_principalsinteger or nullOptional0-10000
notesstring or nullOptional<=2000 characters
statusstring or nullOptional<=20 characters

Free-text status label, at most 20 characters. Defaults to good_standing when omitted.

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.

LocationstringOptional
The new borrower's URL.

Response

Created
borrower_idstring
namestring
created_atdatetime
updated_atdatetime
statusstring
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
legal_entity_typestring or nullOptional
tax_filing_statusstring or nullOptional
tin_last4string or nullOptional
tin_typestring or nullOptional
citystring or nullOptional
statestring or nullOptional
zip_codestring or nullOptional
state_of_formationstring or nullOptional
industrystring or nullOptional
sub_industrystring or nullOptional
naics_codestring or nullOptional
date_establisheddate or nullOptional
fiscal_year_end_monthinteger or nullOptional
number_of_principalsinteger or nullOptional
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
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

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