# Setup # Setup Self-service account and environment creation, between a user interface and the platform's own APIs. Creating an account and its first environment touches several products in a fixed order — identity, environment provisioning, catalogue installation and key issuance. This product carries that sequence so a front end can present it as one step. Per-vendor credential onboarding follows the same shape: each vendor integration exposes an endpoint to store a lender's credentials and another to describe the schema those credentials must satisfy, so the form can be rendered from the schema rather than hand-built per vendor. ## Operations ### Setup `POST` `/setupAccount` #### Setup Account `setup-account` Setup new account. Create new account and send an email ##### Request application/json Copy An example of a payload. ``` { "first_name": "John", "last_name": "Doe", "email": "john.doe@company.com", "company_name": "company", "company_industry": "Mortgage Broker", "company_size": "1-50", "address": "STREET", "zip_code": "00000", "state": "CA", "password": "XXXXX" } ``` ##### Response 200400401403500502 application/json Copy OK. ``` { "transaction_id": "aaaa-bbb-xccccc" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 2 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `Content-Type` required | `string` header | `application/json` | The content type. | ##### Request body`application/json` 10 fields | Field | Type | Description | | --- | --- | --- | | `first_name`required | `string` | First nameExample `John` | | `last_name`required | `string` | Last nameExample `Doe` | | `email`required | `string` | Email of accountExample `john.doe@company.com` | | `company_name`required | `string` | Company nameExample `company` | | `company_industry`required | `string` | Category of companyExample `Mortgage Broker` | | `company_size`required | `string` | Number employees in the companyExample `1-50` | | `address`required | `string` | AddressExample `STREET` | | `zip_code`required | `string` | Zip CodeExample `00000` | | `state`required | `string` | StateExample `CA` | | `password`required | `string` | Password of accountExample `XXXXX` | ##### Response `200``application/json` 1 fields OK. | Field | Type | Description | | --- | --- | --- | | `transaction_id` | `string` | Transaction ID | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `POST` `/refresh_token` #### Refresh Token `Refresh-token` Returns new token when access_token expires ##### Request application/json Copy An example of a payload. ``` { "refresh_token": "" } ``` ##### Response 200400401403500502 application/json Copy OK. ``` { "id_token": "xxxxxx", "refresh_token": "", "token_type": "yyyyyy" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 2 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `Content-Type` required | `string` header | `application/json` | The content type. | ##### Request body`application/json` 1 fields | Field | Type | Description | | --- | --- | --- | | `refresh_token`required | `string` | Token to refreshExample `` | ##### Response `200``application/json` 3 fields OK. | Field | Type | Description | | --- | --- | --- | | `id_token` | `string` | The ID token. | | `refresh_token` | `string` | The refresh token. | | `token_type` | `string` | The token type. | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `POST` `/sign_in` #### Sign In `sign-in` Sign in. Sign in the credentials ##### Request application/json Copy An example of a payload. ``` { "email": "john.doe@company.com", "password": "XXXXX" } ``` ##### Response 200400401403500502 application/json Copy OK. ``` { "id_token": "xxxxxx", "refresh_token": "", "token_type": "yyyyyy" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 2 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `Content-Type` required | `string` header | `application/json` | The content type. | ##### Request body`application/json` 2 fields | Field | Type | Description | | --- | --- | --- | | `email`required | `string` | Email of accountExample `john.doe@company.com` | | `password`required | `string` | Password of accountExample `XXXXX` | ##### Response `200``application/json` 3 fields OK. | Field | Type | Description | | --- | --- | --- | | `id_token` | `string` | The ID token. | | `refresh_token` | `string` | The refresh token. | | `token_type` | `string` | The token type. | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `GET` `/check_email_availability/{email}` #### Check Email Availability `check-Email-Availability` Checks email registered incognito pool ##### Response 200400401403500502 application/json Copy OK. ``` { "status": "AVAILABLE" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 2 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `email` required | `string` path | `john.doe@company.com` | Email of account | ##### Response `200``application/json` 1 fields OK. | Field | Type | Description | | --- | --- | --- | | `status` | `string` | Status of account | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `GET` `/retrieve_all_products` #### Get all products `get-all-products` Get all products from marketplace ##### Response 200400401403500502 application/json Copy OK. ``` { "products": [ { "name": "Account Management", "description": "", "status": "NOT_DEPLOY" } ] } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 2 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `Authorization` required | `string` header | `` | Setup authorization token | ##### Response `200``application/json` 1 fields OK. | Field | Type | Description | | --- | --- | --- | | `products` | `object[]` | List of products | | `name` | `string` | Product name | | `description` | `string` | Description of product | | `status` | `string` | Status of deploy of product (NOT_DEPLOY, IN_QUEUE; FAILED, SUCCESS) | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `GET` `/admin_retrieve_transaction_status` #### Get environment creation status `admin_retrieve_transaction_status` ##### Response 200400401403500502 application/json Copy OK. ``` { "status": "DEPLOYING_INFRASTRUCTURE_PRODUCTS" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 2 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `Authorization` required | `string` header | `` | Setup authorization token | ##### Response `200``application/json` 1 fields OK. | Field | Type | Description | | --- | --- | --- | | `status` | `string` | Status of environment | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `POST` `/submit_customer_api_key` #### Send email `submit-customer-api-key` Submit API key received by email ##### Request application/json Copy An example of a payload. ``` { "api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ``` ##### Response 200400401403500502 application/json Copy OK. ``` { "body": "Task success sent" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 3 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `Content-Type` required | `string` header | `application/json` | The content type. | | `Authorization` required | `string` header | `` | Setup authorization token | ##### Request body`application/json` 1 fields | Field | Type | Description | | --- | --- | --- | | `api_key`required | `string` | API key of environmentExample `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | ##### Response `200``application/json` 1 fields OK. | Field | Type | Description | | --- | --- | --- | | `body` | `string` | Response of endpoint | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `POST` `/submit_product_deploy_options` #### Save product selected `submit-product-deploy-options` Save product selected of environment created in the front-end side ##### Request application/json Copy An example of a payload. ``` { "products_selected": [ "Code", "Assess" ] } ``` ##### Response 200400401403500502 application/json Copy OK. ``` { "body": "Task success sent" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 3 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `Content-Type` required | `string` header | `application/json` | The content type. | | `Authorization` required | `string` header | `` | Setup authorization token | ##### Request body`application/json` 1 fields | Field | Type | Description | | --- | --- | --- | | `products_selected`required | `string[]` | Products selected | ##### Response `200``application/json` 1 fields OK. | Field | Type | Description | | --- | --- | --- | | `body` | `string` | Response of endpoint | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `GET` `/user-info` #### Get information about authenticated user `user-info` ##### Response 200400401403500502 application/json Copy OK. ``` { "UserAttributes": { "sub": "xxxxass-xxx-xxxx-xxxx-xxxxxxxxx", "email_verified": "true", "company_name": "Staircase", "email_confirmed": "False", "api_key_submitted": "True", "last_name": "Doe", "setup_id": "xxxxass-xxx-xxxx-xxxx-xxxxxxxxx", "api_key": "", "first_name": "John", "account_id": "xxxxass-xxx-xxxx-xxxx-xxxxxxxxx", "email": "john.doe@staircase.co", "company_status": "SETUP_COMPLETED", "environment_fqdn": "setup-xxx-xxxxxx.staircaseapi.com" }, "LosAttributes": [ { "provider": "Encompass", "credentials": { "clientId": "xxxxx", "instanceId": "xxxxx", "username": "xxxxx" }, "isAdmin": true, "adminEmail": "", "adminPhone": "" } ] } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 2 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `Authorization` required | `string` header | `` | Setup authorization token | ##### Response `200``application/json` 2 fields OK. | Field | Type | Description | | --- | --- | --- | | `UserAttributes`required | `object` | Information of user | | `sub`required | `string` | ID of user incognito | | `email_verified`required | `string` | Email is verified incognito | | `company_name`required | `string` | Company name of user | | `email_confirmed`required | `string` | Email was confirmed incognito | | `api_key_submitted`required | `string` | If the API key was submitted | | `last_name`required | `string` | Last name | | `setup_id`required | `string` | ID the user in step functions | | `api_key`required | `string` | API key of environment related with the user | | `first_name`required | `string` | First name | | `account_id`required | `string` | ID of user in account product | | `email`required | `string` | Email of user | | `company_status`required | `string` | Status in the flow of setup | | `environment_fqdn`required | `string` | Domain of environment related with the user | | `LosAttributes` | `object[]` | List of LOS Providers | | `provider`required | `string` | Provider name | | `isAdmin`required | `boolean` | Status if the user is admin | | `adminEmail` | `string` | The admin email if the user is not Admin | | `adminPhone` | `string` | The admin phone if the user is not Admin | | `credentials`required | `object` | Credentials of LOS Configuration | | `clientId` | `string` | Client ID of LOS Credentials | | `instanceId` | `string` | Instance ID of LOS Credentials | | `username` | `string` | Username of LOS Credentials | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `POST` `/submit_los_configuration/{provider_name}` #### Create new LOS configuration `submit_LOS_configuration` ##### Request application/json Copy An example of a payload. ``` { "credentials": { "clientId": "xxxxx", "instanceId": "xxxxx", "username": "xxxxx" }, "isAdmin": true, "adminEmail": "", "adminPhone": "" } ``` ##### Response 201400401403500502 application/json Copy OK. ``` { "message": "The credential was stored successfully" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 3 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `provider_name` required | `string` path | `Encompass` | Provider name (NoProvider, Encompass) | | `Authorization` required | `string` header | `` | Setup authorization token | ##### Request body`application/json` 4 fields | Field | Type | Description | | --- | --- | --- | | `isAdmin`required | `boolean` | Status if the user is admin | | `adminEmail` | `string` | The admin email if the user is not Admin | | `adminPhone` | `string` | The admin phone if the user is not Admin | | `credentials`required | `object` | Credentials of LOS Configuration | | `clientId` | `string` | Client ID of LOS Credentials | | `instanceId` | `string` | Instance ID of LOS Credentials | | `username` | `string` | Username of LOS Credentials | ##### Response `201``application/json` 1 fields OK. | Field | Type | Description | | --- | --- | --- | | `message`required | `string` | Created description. | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `POST` `/sms-templates/{product}` #### Create new SMS template by product `create-sms-templates` ##### Request application/json Copy An example of a payload. ``` { "text_body": "xxxxxxxx xxxx xxxxxx" } ``` ##### Response 201400401403500502 application/json Copy Created. ``` { "text_body": "xxxxxxxx xxxx xxxxxx", "name": "sms_template" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 3 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `product` required | `string` path | `Employment` | Product name (Employment, Income) | | `Authorization` required | `string` header | `` | Setup authorization token | ##### Request body`application/json` 1 fields | Field | Type | Description | | --- | --- | --- | | `text_body`required | `string` | Content of template | ##### Response `201``application/json` 2 fields Created. | Field | Type | Description | | --- | --- | --- | | `text_body`required | `string` | Content of template | | `name`required | `string` | Template name | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `GET` `/sms-templates/{product}` #### Retrieve SMS template by product `retrieve-sms-templates` ##### Response 200400401403500502 application/json Copy Created. ``` { "text_body": "xxxxxxxx xxxx xxxxxx", "name": "sms_template" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 3 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `product` required | `string` path | `Employment` | Product name (Employment, Income) | | `Authorization` required | `string` header | `` | Setup authorization token | ##### Response `200``application/json` 2 fields Created. | Field | Type | Description | | --- | --- | --- | | `text_body`required | `string` | Content of template | | `name`required | `string` | Template name | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `POST` `/email-templates/{product}` #### Create new email template by product `create-email-templates` ##### Request application/json Copy An example of a payload. ``` { "html_part": " \n", "subject_part": "xxxx xxxxx", "logo_data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABA4AAAQcCAYAAAAVwNnQAAA" } ``` ##### Response 201400401403500502 application/json Copy Created. ``` { "html_part": " \n", "subject_part": "xxxx xxxxx", "product_name": "Income" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 3 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `product` required | `string` path | `Employment` | Product name (Employment, Income) | | `Authorization` required | `string` header | `` | Setup authorization token | ##### Request body`application/json` 3 fields | Field | Type | Description | | --- | --- | --- | | `html_part`required | `string` | Content of template | | `subject_part`required | `string` | Subject of template | | `logo_data` | `string` | Logo of template in Base64 encode | ##### Response `201``application/json` 3 fields Created. | Field | Type | Description | | --- | --- | --- | | `html_part`required | `string` | Content of template | | `subject_part`required | `string` | Subject of template | | `product_name`required | `string` | Product Name | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `GET` `/email-templates/{product}` #### Retrieve email template by product `retrieve-email-templates` ##### Response 200400401403500502 application/json Copy Created. ``` { "template": { "text_body": "xxxxxxxx xxxx xxxxxx", "name": "sms_template", "logo_image": "xxxxxxxxxxxxxxxxx" } } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 3 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `product` required | `string` path | `Employment` | Product name (Employment, Income) | | `Authorization` required | `string` header | `` | Setup authorization token | ##### Response `200``application/json` 1 fields Created. | Field | Type | Description | | --- | --- | --- | | `template`required | `object` | Information about the template | | `text_body` | `string` | Content of template | | `name` | `string` | Template name | | `logo_image` | `string` | URL of logo | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | `POST` `/vendor/{vendor}/credentials` #### Create credentials by vendor `create-vendor-credentials` ##### Request application/json Copy An example of a payload. ``` { "username": "xxxxxxxx", "password": "", "title_provider_orderings": { "default_ordering": [ "fidelity", "first_american", "stewart" ] } } ``` ##### Response 200400401403422500502 application/json Copy Setup API Triggered Successfully ``` { "message": "Credentials are saved" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy Request data failed validation ``` { "message": "Invalid request body", "error": "[object has missing required properties ([\"client_secret\"])]" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 3 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `vendor` required | `string` path | `ernst` | Vendor name (ernst) | | `Authorization` required | `string` header | `` | Setup authorization token | ##### Request body`application/json` 3 fields | Field | Type | Description | | --- | --- | --- | | `username` | `string` | Username of credential | | `password` | `string` | Password of credential | | `title_provider_orderings`required | `object` | An object to set default title fees' provider list for states, counties and cities | | `default_ordering` | `string[]` | Root default ordering for title fees' provider | | `states` | `object[]` | States | | `state_code` | `string` | State code | | `default_ordering` | `string[]` | Default title provider ordering for the state | | `counties` | `object[]` | Counties | | `county_name` | `string` | County name | | `default_ordering` | `string[]` | Default title provider ordering for the county | | `cities` | `object[]` | Cities | ##### Response `200``application/json` 1 fields Setup API Triggered Successfully | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `422``application/json` 2 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | | `error` | `string` | Message | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Other responses `404` `GET` `/vendor/{vendor}/credentials` #### Retrieve credentials by vendor `retrieve-vendor-credentials` ##### Response 200400401403500502 application/json Copy An example of a payload. ``` { "username": "xxxxxxxx", "password": "", "title_provider_orderings": { "default_ordering": [ "fidelity", "first_american", "stewart" ] } } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 3 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | | `vendor` required | `string` path | `ernst` | Vendor name (ernst) | | `Authorization` required | `string` header | `` | Setup authorization token | ##### Response `200``application/json` 3 fields Setup API Triggered Successfully | Field | Type | Description | | --- | --- | --- | | `username` | `string` | Username of credential | | `password` | `string` | Password of credential | | `title_provider_orderings`required | `object` | An object to set default title fees' provider list for states, counties and cities | | `default_ordering` | `string[]` | Root default ordering for title fees' provider | | `states` | `object[]` | States | | `state_code` | `string` | State code | | `default_ordering` | `string[]` | Default title provider ordering for the state | | `counties` | `object[]` | Counties | | `county_name` | `string` | County name | | `default_ordering` | `string[]` | Default title provider ordering for the county | | `cities` | `object[]` | Cities | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Other responses `404` `POST` `/send-invitation` #### Send an invitation to new customers `send-invitation-customer` ##### Request application/json Copy An example of a payload. ``` { "company_id": "xxxxxxxx", "email": "joedoe@test.co", "first_name": "Joe", "last_name": "Doe" } ``` ##### Response 200400401403500502 application/json Copy Created. ``` { "message": "OK" } ``` application/json Copy Request data failed validation ``` { "message": "{'data': ['Missing data for required field.']}" } ``` application/json Copy Unauthorized validation ``` { "message": "{'data': ['Unauthorized.']}" } ``` application/json Copy Invalid key for service ``` { "message": "Please check the key you used to call this service", "url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post" } ``` application/json Copy The product has encountered an internal server error ``` { "message": "The product has encountered an internal server error" } ``` application/json Copy While acting as a gateway or proxy, received an invalid response from the upstream server. ``` { "message": "The product has encountered an bad gateway error" } ``` ##### Parameters 1 | Parameter | Type | Example | Description | | --- | --- | --- | --- | | `x-api-key` required | `string` header | `` | Key used to identify the API usage plan | ##### Request body`application/json` 4 fields | Field | Type | Description | | --- | --- | --- | | `company_id`required | `string` | The company identifier | | `email`required | `string` | Customer email | | `first_name`required | `string` | Customer name | | `last_name` | `string` | Last Name of customer | ##### Response `200``application/json` 1 fields Created. | Field | Type | Description | | --- | --- | --- | | `message`required | `string` | message | ##### Response `400``application/json` 1 fields Request data failed validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `401``application/json` 1 fields Unauthorized validation | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Message | ##### Response `403``application/json` 2 fields Invalid key for service | Field | Type | Description | | --- | --- | --- | | `message` | `string` | — | | `url` | `string` | — | ##### Response `500``application/json` 1 fields The product has encountered an internal server error | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ##### Response `502``application/json` 1 fields While acting as a gateway or proxy, received an invalid response from the upstream server. | Field | Type | Description | | --- | --- | --- | | `message` | `string` | Error Message | ## Canonical model - `address` - `address` ## Property data it reads - address ## Errors `400``401``403``404``422``500``502` ## More in Distribution - Previous product: Marketplace