Add Renter
POST/api/experian/renters/:renterId
Registers a new renter and initiates the Experian report request process.
Required fields: firstName, lastName, currentAddress, currentCity, currentState, currentZip, ipAddress, jscPayload, hdimPayload
Optional fields include SSN, phone number, driver's license info, employment info, previous address, email, date of birth.
Request
Responses
- 200
- 400
- 403
- 409
- 423
- 502
- 503
Renter registered (or registration step-up required). The payload is the
Experian passive-user response passed through unchanged — depending on the
outcome it contains the authentication challenge (KBA questions or OTP
requirement) plus session identifiers, or the completed registration result.
Required field missing or invalid (errorCode 138, errorOnField names the
field), or a malformed JSON body (errorCode 121).
Missing or invalid X-API-KEY
Either the renter is already registered (errorCode 292), or the account is
not provisioned for live Experian access (errorCode 341).
User blocked by Experian after repeated failed attempts (errorCode 300)
Upstream Experian error or transport failure. errorCode 121 for an upstream
4xx, 131 for an upstream 5xx or a connection failure.
Experian token service unavailable (errorCode 123)