Setup

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"
}

OK.

{
  "transaction_id": "aaaa-bbb-xccccc"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

An example of a payload.

{
  "refresh_token": "<redacted>"
}

OK.

{
  "id_token": "xxxxxx",
  "refresh_token": "<redacted>",
  "token_type": "yyyyyy"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

An example of a payload.

{
  "email": "john.doe@company.com",
  "password": "XXXXX"
}

OK.

{
  "id_token": "xxxxxx",
  "refresh_token": "<redacted>",
  "token_type": "yyyyyy"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

OK.

{
  "status": "AVAILABLE"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

OK.

{
  "products": [
    {
      "name": "Account Management",
      "description": "",
      "status": "NOT_DEPLOY"
    }
  ]
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

OK.

{
  "status": "DEPLOYING_INFRASTRUCTURE_PRODUCTS"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

An example of a payload.

{
  "api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

OK.

{
  "body": "Task success sent"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

An example of a payload.

{
  "products_selected": [
    "Code",
    "Assess"
  ]
}

OK.

{
  "body": "Task success sent"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

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": "<redacted>",
    "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": ""
    }
  ]
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

An example of a payload.

{
  "credentials": {
    "clientId": "xxxxx",
    "instanceId": "xxxxx",
    "username": "xxxxx"
  },
  "isAdmin": true,
  "adminEmail": "",
  "adminPhone": ""
}

OK.

{
  "message": "The credential was stored successfully"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

An example of a payload.

{
  "text_body": "xxxxxxxx xxxx xxxxxx"
}

Created.

{
  "text_body": "xxxxxxxx xxxx xxxxxx",
  "name": "sms_template"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

Created.

{
  "text_body": "xxxxxxxx xxxx xxxxxx",
  "name": "sms_template"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

An example of a payload.

{
  "html_part": "<!DOCTYPE html> <html lang=\"en\"> </html>\n",
  "subject_part": "xxxx xxxxx",
  "logo_data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABA4AAAQcCAYAAAAVwNnQAAA"
}

Created.

{
  "html_part": "<!DOCTYPE html> <html lang=\"en\"> </html>\n",
  "subject_part": "xxxx xxxxx",
  "product_name": "Income"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

Created.

{
  "template": {
    "text_body": "xxxxxxxx xxxx xxxxxx",
    "name": "sms_template",
    "logo_image": "xxxxxxxxxxxxxxxxx"
  }
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

An example of a payload.

{
  "username": "xxxxxxxx",
  "password": "<redacted>",
  "title_provider_orderings": {
    "default_ordering": [
      "fidelity",
      "first_american",
      "stewart"
    ]
  }
}

Setup API Triggered Successfully

{
  "message": "Credentials are saved"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

Request data failed validation

{
  "message": "Invalid request body",
  "error": "[object has missing required properties ([\"client_secret\"])]"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

An example of a payload.

{
  "username": "xxxxxxxx",
  "password": "<redacted>",
  "title_provider_orderings": {
    "default_ordering": [
      "fidelity",
      "first_american",
      "stewart"
    ]
  }
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}

An example of a payload.

{
  "company_id": "xxxxxxxx",
  "email": "joedoe@test.co",
  "first_name": "Joe",
  "last_name": "Doe"
}

Created.

{
  "message": "OK"
}

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}

Unauthorized validation

{
  "message": "{'data': ['Unauthorized.']}"
}

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"
}

The product has encountered an internal server error

{
  "message": "The product has encountered an internal server error"
}

While acting as a gateway or proxy, received an invalid response from the upstream server.

{
  "message": "The product has encountered an bad gateway error"
}