Product

The registry that defines other products: their APIs, their flows, and the uniform endpoint surface every vertical inherits.

A product is created, deployed and documented through this registry. It holds the API definitions, the flow bindings, and the generated interface description each product publishes.

The uniform surface every mortgage vertical carries — request and response schema, the vendor ordering, invocation history, partner list, report templates — is defined once here rather than re-implemented per vertical.

How it works

Two products from different categories expose the same shape, so a caller that has integrated one has most of the work done for the next.

The registry that creates an API is the registry that can list them, so the catalogue is readable as data rather than only as a document.

Operations

APIs

POST /apis

Create API

create_api

Creates API with provided product ID and base path. Next steps are: create resources, create method, deploy the API

Request

application/json

{
  "product_identifier": "ed011136-4199-4efe-8ba1-71b6eb302744",
  "base_path": "product-product",
  "product_category": "Integration",
  "product_family": "Platform",
  "product_name": "Product"
}

Response

application/json

OK Response

{
  "api_id": "3f6eb765-459d-4a84-a985-620628e7a2cf",
  "product_identifier": "ed011136-4199-4efe-8ba1-71b6eb302744",
  "base_path": "credit"
}

Request body`application/json`

5 fields

Field	Type	Description
`product_identifier`	`string (uuid)`	Product ID.
`base_path`	`string`	Base path
`product_category`	`string`	Product category from Staircase Ontology
`product_family`	`string`	Product family from Staircase Ontology
`product_name`	`string`	Product name from Staircase ontology

Response `201application/json`

3 fields

OK Response

Field	Type	Description
`api_id`	`string (uuid)`	API ID
`product_identifier`	`string (uuid)`	Product ID
`base_path`	`string`	Base path

Response `400application/json`

1 fields

Request data failed validation

Field	Type	Description
`message`	`one of`	Message

Response `403application/json`

1 fields

Missing API key

Field	Type	Description
`message`	`string`	Message

Response `409application/json`

1 fields

Resource already exists.

Field	Type	Description
`message`	`string`	Error Message.

Response `422application/json`

1 fields

Resource already exists.

Field	Type	Description
`message`	`string`	Error Message.

POST /apis/{product_identifier}/endpoints

Create Endpoint

create_endpoint

Create endpoint.

Create endpoint for API, that was created with specified product identifier. Endpoint contains two parts: it's public definition, that will be available and will be presented in OpenAPI file and integration with any Staircase API. When your endpoint will be invoked request parameters and body will be mapped according to your definition and request will be sent to specified Staircase API, same will happen with the response. To create valid integration you need to specify HTTP method that will be used for request in integration.http_method, url without domain name, f.e. /persistence/transactions in integration.url, request schema, if needed, in request_schema in JSON Schema format. Incoming requests will be validated against that schema and in case of invalid request your customer will receive response with status code 400 and error message in body. To map request parameters you need to fill integration.request_parameters parameter with an object, where keys are location where to put them for request to Staircase service in format {location}.{name} where location is querystring , path , or header and name is a valid and unique parameter name and values are static value or, if you want to map them from the request, value should match patter request.{location}.{name} where location is querystring , path , or header and name must be a valid and unique method request parameter name. To map request body you need to specify integration.request_template in format of VTL template. VTL is simple template language, you can find information about all possibilities here. Basic examples can be found in request examples for this endpoint. Inside template, you will be to access two variables: $input and $util. The $input variable represents the method request payload and parameters to be processed by a mapping template. It provides four functions:

Show the rest

Variable and function	Description
$input.body	Returns the raw request payload as a string.
$input.json(x)	This function evaluates a JSONPath expression and returns the results as a JSON string. For example, $input.json('$.pets') returns a JSON string representing the pets structure. For more information about JSONPath, see JSONPath
$input.params	Returns a map of all the request parameters. We recommend that you use $util.escapeJavaScript to sanitize the result to avoid a potential injection attack. For full control of request sanitization, use a proxy integration without a template and handle request sanitization in your integration.
$input.params(x)	Returns the value of a method request parameter from the path, query string, or header value (searched in that order), given a parameter name string x. We recommend that you use $util.escapeJavaScript to sanitize the parameter to avoid a potential injection attack. For full control of parameter sanitization, use a proxy integration without a template and handle request sanitization in your integration.
$input.path(x)	Takes a JSONPath expression string (x) and returns a JSON object representation of the result. This allows you to access and manipulate elements of the payload natively in Apache Velocity Template Language (VTL).

`$input` Variable template examples

Parameter mapping template example

The following parameter-mapping example passes all parameters, including path, querystring, and header, through to the integration endpoint via a JSON payload:

#set($allParams = $input.params)
{
 "params" : {
 #foreach($type in $allParams.keySet)
 #set($params = $allParams.get($type))
 "$type" : {
 #foreach($paramName in $params.keySet)
 "$paramName" : "$util.escapeJavaScript($params.get($paramName))"
 #if($foreach.hasNext),#end
 #end
 }
 #if($foreach.hasNext),#end
 #end
 }
}

In effect, this mapping template outputs all the request parameters in the payload as outlined as follows:

{
 "params" : {
 "path" : { 
 "path_name" : "path_value", 
 ...
 }
 "header" : { 
 "header_name" : "header_value",
 ...
 }
 "querystring" : {
 "querystring_name" : "querystring_value",
 ...
 }
 }
}

Example JSON mapping template using `$input`

The following example shows how to use a mapping to read a name from the query string and then include the entire POST body in an element:

{
 "name" : "$input.params('name')",
 "body" : $input.json('$') 
}

If the JSON input contains unescaped characters that cannot be parsed by JavaScript, a 400 response may be returned. Applying $util.escapeJavaScript($input.json('$')) above will ensure that the JSON input can be parsed properly.

Example mapping template using `$input`

The following example shows how to pass a JSONPath expression to the json method. You could also read a specific property of your request body object by using a period (.), followed by your property name:

{
 "name" : "$input.params('name')",
 "body" : $input.json('$.mykey') 
}

If a method request payload contains unescaped characters that cannot be parsed by JavaScript, you may get 400 response. In this case, you need to call $util.escapeJavaScript function in the mapping template, as shown as follows:

{
 "name" : "$input.params('name')",
 "body" : $util.escapeJavaScript($input.json('$.mykey')) 
}

Example request and response using `$input`

Request template

Resource: /things/{id}

With input template:
{
 "id" : "$input.params('id')",
 "count" : "$input.path('$.things').size",
 "things" : $util.escapeJavaScript($input.json('$.things'))
}

POST /things/abc
{
 "things" : {
 "1" : {},
 "2" : {},
 "3" : {}
 }
}

Response:

{
 "id": "abc",
 "count": "3",
 "things": {
 "1": {},
 "2": {},
 "3": {}
 }
}

$util Variables

Function	Description
$util.escapeJavaScript	Escapes the characters in a string using JavaScript string rules. Note: This function will turn any regular single quotes (') into escaped ones ('). However, the escaped single quotes are not valid in JSON. Thus, when the output from this function is used in a JSON property, you must turn any escaped single quotes (') back to regular single quotes ('). This is shown in the following example: `$util.escapeJavaScript(data).replaceAll("\\'","'")`
$util.parseJson	Takes "stringified" JSON and returns an object representation of the result. You can use the result from this function to access and manipulate elements of the payload natively in Apache Velocity Template Language (VTL). For example, if you have the following payload: `{"errorMessage":"{\"key1\":\"var1\",\"key2\":{\"arr\":[1,2,3]}}"}` and use the following mapping template `#set ($errorMessageObj = $util.parseJson($input.path('$.errorMessage'))) { "errorMessageObjKey2ArrVal" : $errorMessageObj.key2.arr[0] }` You will get the following output: `{"errorMessageObjKey2ArrVal": 1}`
$util.urlEncode	Converts a string into "application/x-www-form-urlencoded" format.
$util.urlDecode	Decodes an "application/x-www-form-urlencoded" string.
$util.base64Encode	$util.base64Encode
$util.base64Decode	Decodes the data from a base64-encoded string.

Request

application/json

POST request with request body

{
  "path": "/loans",
  "http_method": "POST",
  "product_api_identifiers": [
    "5b3b5eb4-f32f-487f-9969-2a9b0ddef89e",
    "e37b044f-b992-4c23-b588-1c34dbb3008b"
  ],
  "product_component": "Loans",
  "product_endpoint": "Create loan",
  "product_sequence": 1,
  "operation_id": "create_loan",
  "description": "Create Loan",
  "example": {
    "loan_label": "foo"
  },
  "request_schema": {
    "type": "object",
    "properties": {
      "loan_label": {
        "type": "string"
      }
    },
    "required": [
      "loan_label"
    ],
    "additionalProperties": false
  },
  "integration": {
    "http_method": "POST",
    "url": "/persistence/transactions",
    "request_template": "{\"label\": \"$input.path('$.loan_label')\"}",
    "responses": {
      "201": {
        "documentation": {
          "description": "Loan created.",
          "example": {
            "loan_label": "foo",
            "loan_id": "01GKF9A4QZ79RSCMJ041HEZSMK"
          }
        },
        "schema": {
          "type": "object",
          "properties": {
            "loan_label": {
              "type": "string"
            },
            "loan_id": {
              "type": "string"
            }
          }
        },
        "response_template": "#set($inputRoot = $input.path('$'))\n{\n  \"loan_label\": \"$inputRoot.label\",\n  \"loan_id\": \"$inputRoot.transaction_id\"\n}\n"
      }
    }
  }
}

application/json

GET request with path parameters mapping

{
  "path": "/loans/{loan_id}",
  "http_method": "GET",
  "product_api_identifiers": [
    "fec297a3-973d-4b68-be48-d7a4aedcb07f"
  ],
  "product_component": "Loans",
  "product_endpoint": "Retrieve Loan",
  "product_sequence": 2,
  "operation_id": "retrieve_loan",
  "parameters": [
    {
      "in": "path",
      "name": "loan_id",
      "required": true,
      "schema": {
        "type": "string"
      },
      "example": "01GKKGSG9NHCTP1XM8W4W833QD"
    }
  ],
  "integration": {
    "http_method": "GET",
    "url": "/persistence/transactions/{transaction_id}",
    "request_parameters": {
      "path.transaction_id": "request.path.loan_id"
    },
    "responses": {
      "200": {
        "response_template": "#set($inputRoot = $input.path('$')){ \"loan_label\": \"$inputRoot.label\", \"loan_id\": \"$inputRoot.transaction_id\", \"created_at\": \"$inputRoot.created_at\"}",
        "schema": {
          "type": "object",
          "properties": {
            "loan_label": {
              "type": "string",
              "description": "Loan label."
            },
            "loan_id": {
              "type": "string",
              "description": "Loan ID."
            },
            "created_at": {
              "type": "string",
              "format": "datetime",
              "description": "Loan created at."
            }
          }
        },
        "documentation": {
          "description": "Loan",
          "example": {
            "loan_label": "foo",
            "loan_id": "01GKF9A4QZ79RSCMJ041HEZSMK",
            "created_at": "2022-12-04T21:23:54"
          }
        }
      },
      "404": {
        "response_template": "$input.json('$')",
        "documentation": {
          "description": "Not found",
          "example": {
            "message": "Loan not found."
          }
        },
        "schema": {
          "type": "object",
          "properties": {
            "message": {
              "type": "string",
              "description": "Error message."
            }
          }
        }
      }
    }
  }
}

Response

application/json

OK Response

{
  "product_identifier": "ed011136-4199-4efe-8ba1-71b6eb302744",
  "path": "/loans",
  "http_method": "POST"
}

Parameters

Parameter	Type	Example	Description
`product_identifier` required	`string (uuid)` path	`foo`	Product ID

Request body`application/json`

12 fields

Field	Type	Description
`path`required	`string`	Path of your endpoint. Have to start with '/'
`http_method`required	`string`	HTTP method of your endpoint.`DELETEGETPATCHPOSTPUT`
`operation_id`required	`string`	Operation id of your endpoint. Used for OpenAPI generation.
`request_schema`	`object`	Request schema
`product_api_identifiers`required	`string[]`	Product API identifiers
`product_component`required	`string`	Product component
`product_endpoint`required	`string`	Product endpoint
`product_sequence`required	`integer`	Product sequence for Site product
`description`	`string`	Description
`example`	`object`	Request body example
`parameters`	`object[]`	Description and examples for path/query/headers parameters
`in`required	`string`	Location, where your parameters is presented.`headerpathquery`
`name`required	`string`	Name of your parameter
`schema`required	`object`	JSON schema of your parameter
`type`required	`string`	Data type of your parameter`booleanintegernumberstring`
`example`required	`string`	Example of your parameter
`integration`required	`object`	Your integration information
`http_method`	`string`	HTTP method of request your API will make to Staircase API
`url`	`string`	URL part without domain name of request your API will make to Staircase API
`request_template`	`string`	VTL request template that defines request body of request your API will make to Staircase API
`request_parameters`	`string`	Mapping between path/query/header parameters from request that your API receives to the Staircase API
`responses`	`object`	Information about processing responses from Staircase API, that you call. Key has to be status code, that will process.

Response `201application/json`

3 fields

OK Response

Field	Type	Description
`product_identifier`	`string (uuid)`	Product ID
`path`	`string (string)`	path
`http_method`	`string`	method

Response `400application/json`

1 fields

Request data failed validation

Field	Type	Description
`message`	`one of`	Message

Response `403application/json`

1 fields

Missing API key

Field	Type	Description
`message`	`string`	Message

Response `404application/json`

1 fields

Requested resource is not found

Field	Type	Description
`message`	`string`	Message

GET /apis

List APIs [new]

list_apis

List APIs

List APIs. Response may not have APIs but contains next_token. That means that there are results on next pages

Response

application/json

OK Response

{
  "next_token": "7b22504b223a2022666f6f222c2022534b223a2022626172227d",
  "apis": [
    {
      "product_identifier": "ed011136-4199-4efe-8ba1-71b6eb302744",
      "base_path": "product-product",
      "is_deployed": true
    },
    {
      "product_identifier": "0206ce61-ed46-492d-98be-9d7f5f166e7d",
      "base_path": "foo/bar",
      "is_deployed": false
    }
  ]
}

Parameters

Parameter	Type	Example	Description
`next_token`	`string` query	`31132629274945519779805322857203735586714454643391594505`	Next token for pagination
`limit`	`integer` query	`5`	Items limit

Response `200application/json`

2 fields

OK Response

Field	Type	Description
`next_token`	`string`	Pagination token
`apis`	`object[]`	APIs
`product_identifier`	`string (uuid)`	Product ID
`base_path`	`string`	Base path
`is_deployed`	`boolean`	Indicator if API was deployed at least once

Response `400application/json`

1 fields

Request data failed validation

Field	Type	Description
`message`	`one of`	Message

Response `403application/json`

1 fields

Missing API key

Field	Type	Description
`message`	`string`	Message

Response `404application/json`

1 fields

Requested resource is not found

Field	Type	Description
`message`	`string`	Message

POST /apis/{product_identifier}/deploy

Deploy API

deploy_api

Deploys your API with specified product identifier. Deployed changes will be available in few minutes after deployment

Response

application/json

OK Response

{
  "product_identifier": "ed011136-4199-4efe-8ba1-71b6eb302744",
  "status": "DEPLOY_IN_PROGRESS"
}

Parameters

Parameter	Type	Example	Description
`product_identifier` required	`string (uuid)` path	`foo`	Product ID

Response `200application/json`

2 fields

OK Response

Field	Type	Description
`product_identifier`	`string (uuid)`	Product ID
`status`	`string`	Status

Response `400application/json`

1 fields

Request data failed validation

Field	Type	Description
`message`	`one of`	Message

Response `403application/json`

1 fields

Missing API key

Field	Type	Description
`message`	`string`	Message

Response `404application/json`

1 fields

Requested resource is not found

Field	Type	Description
`message`	`string`	Message

Response `429application/json`

1 fields

Too many requests.

Field	Type	Description
`message`	`string`	Error Message.

GET /apis/{product_identifier}/openapi

Retrieve OpenAPI

get_openapi

Retrieve OpenAPI of deployment API. Changes that are not deployed will not be presented in the OpenAPI.

Response

application/json

OK Response

{}

Parameters

Parameter	Type	Example	Description
`product_identifier` required	`string (uuid)` path	`foo`	Product ID

Response `400application/json`

1 fields

Request data failed validation

Field	Type	Description
`message`	`one of`	Message

Response `403application/json`

1 fields

Missing API key

Field	Type	Description
`message`	`string`	Message

Response `404application/json`

1 fields

Requested resource is not found

Field	Type	Description
`message`	`string`	Message

Other responses

200

GET /apis/{product_identifier}/logs

Retrieve Logs

get_logs

Retrieve list of API invocations logs.

Response

application/json

OK Response

{
  "logs": [
    {
      "log_id": "05a50ea791fe0795d12a6745d010946f",
      "last_event_datetime": "2022-12-16T12:53:15.686298"
    }
  ]
}

Parameters

Parameter	Type	Example	Description
`product_identifier` required	`string (uuid)` path	`foo`	Product ID
`next_token`	`string` query	`31132629274945519779805322857203735586714454643391594505`	Next token for pagination
`limit`	`integer` query	`5`	Items limit

Response `200application/json`

2 fields

OK Response

Field	Type	Description
`next_token`	`string`	Pagination token
`logs`	`object[]`	Logs
`log_id`	`string`	Log ID
`last_event_datetime`	`string (date-time)`	Last event date time

Response `400application/json`

1 fields

Request data failed validation

Field	Type	Description
`message`	`one of`	Message

Response `403application/json`

1 fields

Missing API key

Field	Type	Description
`message`	`string`	Message

Response `404application/json`

1 fields

Requested resource is not found

Field	Type	Description
`message`	`string`	Message

GET /apis/{product_identifier}/logs/{log_id}

Retrieve Log Events

get_log

Retrieve Logs

Retrieve log events.

Response

application/json

OK Response

{
  "events": [
    {
      "timestamp": "2022-12-16T10:33:29.067",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Extended Request Id: dOwF8HWWoAMF4BQ="
    },
    {
      "timestamp": "2022-12-16T10:33:29.068",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Verifying Usage Plan for request: 8f575720-12c8-46e3-93dd-315bca0e4d42. API Key: ******************************0300c8 API Stage: 4g92h4obi0/api"
    },
    {
      "timestamp": "2022-12-16T10:33:29.070",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Usage Plan check succeeded for API Key ******************************0300c8 and API Stage 4g92h4obi0/api"
    },
    {
      "timestamp": "2022-12-16T10:33:29.070",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Starting execution for request: 8f575720-12c8-46e3-93dd-315bca0e4d42"
    },
    {
      "timestamp": "2022-12-16T10:33:29.070",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) HTTP Method: POST, Resource Path: /c757967a-c988-4119-b857-1f4691508d02/loans"
    },
    {
      "timestamp": "2022-12-16T10:33:29.070",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) API Key: ******************************0300c8"
    },
    {
      "timestamp": "2022-12-16T10:33:29.070",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) API Key ID: 2i75ejp0oa"
    },
    {
      "timestamp": "2022-12-16T10:33:29.070",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Method request path: {}"
    },
    {
      "timestamp": "2022-12-16T10:33:29.070",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Method request query string: {}"
    },
    {
      "timestamp": "2022-12-16T10:33:29.070",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Method request headers: {x-api-key=******************************0300c8, User-Agent=python-requests/2.28.1, X-Forwarded-Proto=https, X-Amz-Cf-Id=KbOkVNYF-kYDISmt1P2Np-Wlp6qIpxzKN5xbB0hk6CTWGZbFRrvuXw==, X-Forwarded-For=74.91.0.55, 15.158.35.43, content-type=application/json, Host=persistence.staircaseapi.com, X-Forwarded-Port=443, accept-encoding=gzip, deflate, X-Amzn-Trace-Id=Root=1-639c2d59-2293811d029398d96147cf54, accept=*/*, via=1.1 008cd6752eb718142dfefe2f7e847982.cloudfront.net (CloudFront)}"
    },
    {
      "timestamp": "2022-12-16T10:33:29.070",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Method request body before transformations: {\"loan_label\": \"foo\"}"
    },
    {
      "timestamp": "2022-12-16T10:33:29.070",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Request validation succeeded for content type application/json"
    },
    {
      "timestamp": "2022-12-16T10:33:29.074",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Endpoint request URI: https://persistence.staircaseapi.com/persistence/transactions"
    },
    {
      "timestamp": "2022-12-16T10:33:29.074",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Endpoint request headers: {x-amzn-apigateway-api-id=4g92h4obi0, Accept=application/json, x-api-key=******************************0300c8, User-Agent=AmazonAPIGateway_4g92h4obi0, X-Amzn-Trace-Id=Root=1-639c2d59-2293811d029398d96147cf54, Content-Type=application/json}"
    },
    {
      "timestamp": "2022-12-16T10:33:29.074",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Endpoint request body after transformations: {\"label\": \"foo\"}"
    },
    {
      "timestamp": "2022-12-16T10:33:29.074",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Sending request to https://persistence.staircaseapi.com/persistence/transactions"
    },
    {
      "timestamp": "2022-12-16T10:33:32.561",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Received response. Status: 201, Integration latency: 3487 ms"
    },
    {
      "timestamp": "2022-12-16T10:33:32.561",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Endpoint response headers: {Content-Type=application/json, Content-Length=245, Connection=keep-alive, Date=Fri, 16 Dec 2022 08:33:32 GMT, x-amzn-RequestId=4eb2676a-9f6d-4a71-abd3-8d51ab2075fd, access-control-allow-origin=*, strict-transport-security=max-age=31536000; includeSubDomains; preload, access-control-allow-headers=Authorization,Content-Type,X-Amz-Date,X-Amz-Security-Token,X-Api-Key, x-amz-apigw-id=dOwF9ELkIAMFUtw=, X-Amzn-Trace-Id=Root=1-639c2d59-2293811d029398d96147cf54;Sampled=1, X-Cache=Miss from cloudfront, Via=1.1 640e1fde1214554c9f15c8cb85df826a.cloudfront.net (CloudFront), X-Amz-Cf-Pop=IAD55-P2, X-Amz-Cf-Id=ybYqTc-fhx_uPoQPcRLyd0VofrIirq_NFEEAWNjOmrOPpusYN4HNsw==}"
    },
    {
      "timestamp": "2022-12-16T10:33:32.561",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Endpoint response body before transformations: {\"label\": \"foo\",\"created_at\": \"2022-12-16T03:33:32.498711-05:00\",\"transaction_id\": \"01GMD12CAJ5FCV4SW837WCJZ2Y\",\"_links\": {\"collections\": \"https://persistence.staircaseapi.com/persistence/transactions/01GMD12CAJ5FCV4SW837WCJZ2Y/collections\"}}"
    },
    {
      "timestamp": "2022-12-16T10:33:32.561",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Method response body after transformations: {\"loan_label\": \"foo\",\"loan_id\": \"01GMD12CAJ5FCV4SW837WCJZ2Y\"}"
    },
    {
      "timestamp": "2022-12-16T10:33:32.562",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Method response headers: {X-Amzn-Trace-Id=Root=1-639c2d59-2293811d029398d96147cf54;Sampled=1, Access-Control-Allow-Headers=Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,X-Amz-User-Agent, Access-Control-Allow-Origin=*, Access-Control-Allow-Methods=GET,DELETE,OPTIONS,PATCH,POST,PUT, Strict-Transport-Security=max-age=31536000; includeSubDomains; preload, Content-Type=application/json}"
    },
    {
      "timestamp": "2022-12-16T10:33:32.562",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Successfully completed execution"
    },
    {
      "timestamp": "2022-12-16T10:33:32.562",
      "message": "(8f575720-12c8-46e3-93dd-315bca0e4d42) Method completed with status: 201"
    }
  ]
}

Parameters

Parameter	Type	Example	Description
`product_identifier` required	`string (uuid)` path	`foo`	Product ID
`log_id` required	`string` path	`05a50ea791fe0795d12a6745d010946f`	Log ID
`next_token`	`string` query	`31132629274945519779805322857203735586714454643391594505`	Next token for pagination
`limit`	`integer` query	`5`	Items limit

Response `200application/json`

2 fields

OK Response

Field	Type	Description
`next_token`	`string`	Pagination token
`events`	`—`	Events

Response `400application/json`

1 fields

Request data failed validation

Field	Type	Description
`message`	`one of`	Message

Response `403application/json`

1 fields

Missing API key

Field	Type	Description
`message`	`string`	Message

Response `404application/json`

1 fields

Requested resource is not found

Field	Type	Description
`message`	`string`	Message

DELETE /apis/{product_identifier}

Delete API

delete_api

Delete API.

Service deletes the API and all the endpoints of this API.

Response

application/json

Request data failed validation

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

Parameters

Parameter	Type	Example	Description
`product_identifier` required	`string (uuid)` path	`b1e98e0e-adnf-4cdd-b065-16feb5493049`	Product ID

Response `400application/json`

1 fields

Request data failed validation

Field	Type	Description
`message`	`one of`	Message

Response `403application/json`

1 fields

Missing API key

Field	Type	Description
`message`	`string`	Message

Response `404application/json`

1 fields

Requested resource is not found

Field	Type	Description
`message`	`string`	Message

Response `429application/json`

1 fields

Too many requests.

Field	Type	Description
`message`	`string`	Error Message.

Other responses

204

Api Examples

POST /apis-examples/subsets

Generate Subset

generate_subset

Extract the part of the JSON data by the provided api schema definition in Lexicon format.

Request

application/json

{
  "api_data_example": {
    "foo": [
      {
        "bar1": "baz1"
      },
      {
        "bar2": "baz2"
      }
    ],
    "bar": {
      "biz": "baz",
      "booz": "baz"
    }
  },
  "root_schema_fields": [
    "foo_schema_id",
    "bar_schema_id"
  ],
  "all_schema_fields": [
    {
      "@id": "foo_schema_id",
      "@type": "api_schema",
      "name": "foo",
      "requirement_indicator": true,
      "has_graph_entity": "01H28AB7BRQ066FJCHXEN1SW7T",
      "has_api_schema_field": [
        "bar1_schema_id"
      ]
    },
    {
      "@id": "bar1_schema_id",
      "@type": "api_schema",
      "name": "bar1",
      "requirement_indicator": false,
      "has_graph_entity": "01H28AB7BRGBRJDC3CD7Y3S0C7"
    },
    {
      "@id": "bar_schema_id",
      "@type": "api_schema",
      "name": "bar",
      "requirement_indicator": true,
      "has_graph_entity": "01H28AB7BRQ066FJCHXEN1SW7O",
      "has_api_schema_field": [
        "booz_schema_id"
      ]
    },
    {
      "@id": "booz_schema_id",
      "@type": "api_schema",
      "name": "booz",
      "requirement_indicator": false,
      "has_graph_entity": "01H28AB7BRGBRJDC3CD7Y3S0C7"
    }
  ]
}

Response

application/json

Created item successfully

{
  "example_data_subset": {
    "foo": [
      {
        "bar1": "baz1"
      }
    ],
    "bar": {
      "booz": "baz"
    }
  }
}

Request body`application/json`

3 fields

Field	Type	Description
`api_data_example`required	`one of`	The complete JSON data to be processed.
`root_schema_fields`required	`string[]`	The @id-s of the root data children datapoints.
`all_schema_fields`required	`object[]`	The api schema definition in `Lexicon` format.
`name`required	`string`	Data property name.
`has_api_schema_fields`	`string[]`	JSON-LD @id-s of the schema definitions for the child data points.

Response `201application/json`

1 fields

Created item successfully

Field	Type	Description
`example_data_subset`	`one of`	Generated subset of the API example data.

Response `400application/json`

2 fields

Request data failed validation

Field	Type	Description
`detailedMessage`	`string`	Message
`code`	`string`	Code

Response `403application/json`

1 fields

Missing API key

Field	Type	Description
`message`	`string`	Message

Loans

POST /loans

Create loan

Create Loan

Request

application/json

{
  "loan_label": "foo"
}

Response

application/json

Loan created.

{
  "loan_label": "foo",
  "loan_id": "01GKF9A4QZ79RSCMJ041HEZSMK"
}

Parameters

Parameter	Type	Description
`x-api-key` required	`string` header	—

Request body`application/json`

1 fields

Field	Type	Description
`loan_label`required	`string`	—

Response `201application/json`

2 fields

Loan created.

Field	Type	Description
`loan_label`	`string`	—
`loan_id`	`string`	—

Operations

GET /{product}/connector-configurations

Retrieve Connector Configurations

retrieve-connector-configurations

Retrieve the all connector configurations for the given product. The configuration field can be passed as a path parameter the /setups endpoint.

Response

application/json

Connector Configurations Found

[
  {
    "configuration": "test",
    "partners": [
      {
        "partner": "plaid"
      },
      {
        "partner": "finicity"
      }
    ]
  },
  {
    "configuration": "production",
    "partners": [
      {
        "partner": "plaid"
      },
      {
        "partner": "finicity"
      }
    ]
  }
]

application/json

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

Parameters

Parameter	Type	Description
`product` required	`string` path	Staircase product name

Response `200application/json`

2 fields

Connector Configurations Found

Field	Type	Description
`configuration`	`string`	Name of the configuration. Can be passed into the /setups endpoint.
`partners`	`object[]`	An array of vendors associated with the configuration
`partner`	`string`	Name of the vendor

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `404application/json`

1 fields

Connector configuration not found

Field	Type	Description
`message`	`string`	Message

Other responses

400

POST /{product}/connector-configurations/{configuration}/setups

Set up Connector Configuration

setup-connector-configuration

Set up a connector configuration by passing product and configuration name. You can check the type of configurations by using the GET /connector-configurations endpoint.

Response

application/json

Configuration set up successfully

{
  "message": "Configuration is set up successfully."
}

application/json

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

Parameters

Parameter	Type	Description
`product` required	`string` path	Staircase product name
`configuration` required	`string` path	Product configuration name

Response `200application/json`

1 fields

Configuration set up successfully

Field	Type	Description
`message`	`string`	Message

Response `403application/json`

2 fields

Invalid key for service

Field	Type	Description
`message`	`string`	—
`url`	`string`	—

Response `404application/json`

1 fields

Resource not found

Field	Type	Description
`message`	`string`	Message

Other responses

400

POST /build

Build payload

Build a payload for collections, where the pathes can be taken from appropriate endpoint. Values, that are passed is validated against the JSON schema.

Request

application/json

{
  "$.deal_sets[0].parties[0].individual.first_name": "Mykyta",
  "$.deal_sets[0].parties[0].roles[0].party_type": "Borrower",
  "$.deal_sets[0].parties[0].roles[0].employers[0].legal_entity_name": "Truework Inc",
  "$.deal_sets[0].parties[0].taxpayer_identifiers[0].value": "999-00-0000"
}

Response

application/json

200 response

{
  "deal_sets": {
    "deal_set": [
      {
        "deals": {
          "deal": [
            {
              "parties": {
                "party": [
                  {
                    "individual": {
                      "name": "Mykyta"
                    },
                    "roles": {
                      "role": [
                        {
                          "role_detail": {
                            "party_type": "Borrower"
                          },
                          "borrower": {
                            "employers": {
                              "employer": [
                                {
                                  "legal_entity": {
                                    "legal_entity_detail": {
                                      "full_name": "Truework Inc"
                                    }
                                  }
                                }
                              ]
                            }
                          }
                        }
                      ]
                    },
                    "taxpayer_identifiers": {
                      "taxpayer_identifier": [
                        {
                          "type": "EmployerIdentificationNumber",
                          "value": "999-00-0000"
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Other responses

200

POST /hello-world

Hello World

Dummy hello world endpoint

Other responses

200

GET /loans/{loan_id}

Response

application/json

Loan

{
  "loan_label": "foo",
  "loan_id": "01GKF9A4QZ79RSCMJ041HEZSMK",
  "created_at": "2022-12-04T21:23:54"
}

Parameters

Parameter	Type	Example	Description
`x-api-key` required	`string` header	—	—
`loan_id` required	`string` path	`01GKKGSG9NHCTP1XM8W4W833QD`	—

Response `200application/json`

3 fields

Loan

Field	Type	Description
`loan_label`	`string`	Loan label.
`loan_id`	`string`	Loan ID.
`created_at`	`string (datetime)`	Loan created at.

Response `404application/json`

1 fields

Not found

Field	Type	Description
`message`	`string`	Error message.

GET /schema

Retrieve part of staircase json schema by json path

returns the schema for specified JSON path, that it is used for payload validation

Response

application/json

200 response

{
  "type": "string",
  "description": "An identifier for the current instance of VIEW. The party assigning the identifier should be provided using the IdentifierOwnerURI."
}

Parameters

Parameter	Type	Example	Description
`json_path` required	`string` query	`$.deal_sets[0].parties[0].individual.first_name`	—

Other responses

200

POST /sdks

Generate SDK for the specific service

Using input link to swagger and request details generate SDK for the service

Request body`application/json`

4 fields

Field	Type	Description
`service_name`	`string`	Name of service for which sdk need to be generated
`swagger_link`	`string`	Link to swagger (OpenAPI) json file which need to be used for SDK generation
`programming_language`	`string`	Programming language for which we need to generate SDK
`service_version`	`string`	Version of service

Response `201application/json`

3 fields

SDK generated successfully

Field	Type	Description
`message`	`string`	Status message of SDK generation process
`success`	`boolean`	Does operation generate SDK
`generated_sdk_url`	`string`	URL to generated SDK on s3 bucket

Response `400application/json`

2 fields

Bad request body

Field	Type	Description
`error_message`	`string`	Short error reason message
`error_description`	`string`	Long description of error cause

Response `409application/json`

3 fields

SDK with provided parameters already exist

Field	Type	Description
`message`	`string`	Status message of SDK generation process
`success`	`boolean`	Does operation generate SDK
`generated_sdk_url`	`string`	URL to generated SDK on s3 bucket

DELETE /sdks/{programming_language}/{service_name}

Delete existing SDK with service_version bucket

Delete SDK inside service_version bucket and this bucket itself

Parameters

Parameter	Type	Description
`programming_language` required	`string` path	SDK client language
`service_name` required	`string` path	Name of service
`service_version` required	`string` query	The version of service for which we need delete SDK

Response `200application/json`

2 fields

SDK and service_version bucket was deleted successfully

Field	Type	Description
`success`	`boolean`	Show the success status of deletion process
`description`	`string`	Short description message of success status

Response `404application/json`

2 fields

Not found any SDK's related to requested parameters

Field	Type	Description
`success`	`boolean`	Show the success status of deletion process
`description`	`string`	Short description message of success status

Other responses

400

GET /sdks/{programming_language}/{service_name}

Get S3 bucket url's to SDK's for reuqested parameters

Get all existing S3 bucket url's to SDK's for the requested programming language , service name and version

Parameters

Parameter	Type	Description
`programming_language` required	`string` path	Name of programming language for which we need to download SDK
`service_name` required	`string` path	Name of service for the requested SDK
`service_version`	`string` query	Version of service

Response `200multipart/form-data`

2 fields

Found SDK's for the requested parameters

Field	Type	Description
`sdk_version`	`string`	Version of service SDK
`generated_sdk_url`	`string`	URL of generated SDK to S3 bucket

Other responses

404

POST /validate

Validate OpenAPI file

Request body`application/json`

1 fields

Field	Type	Description
`url`	`string`	url to swagger file

Response `400application/json`

1 fields

Validator found some errors

Field	Type	Description
`errors`	`object[]`	—
`error_type`	`string`	—
`message`	`string`	—

Other responses

200

POST /validate/{language}

Validate element

validate_element

Parameters

Parameter	Type	Description
`x-api-key` required	`string` header	API key
`language` required	`string` path	Language name

Request body`application/json`

2 fields

Field	Type	Description
`values`	`object`	—
`element_type`	`string`	—

Response `200application/json`

2 fields

Element is valid

Field	Type	Description
`values`	`object`	—
`element_type`	`string`	—

Response `400application/json`

1 fields

Validation failed

Field	Type	Description
`errors`	`object[]`	—
`error_type`	`string`	—
`message`	`string`	—

Errors

400403404409422429

How it works

Operations

APIs

Create API

Request

Response

Request bodyapplication/json

Response 201application/json

Response 400application/json

Response 403application/json

Response 409application/json

Response 422application/json

Create Endpoint

$input Variable template examples

Parameter mapping template example

Example JSON mapping template using $input

Example mapping template using $input

Example request and response using $input

$util Variables

Request

Response

Parameters

Request bodyapplication/json

Response 201application/json

Response 400application/json

Response 403application/json

Response 404application/json

List APIs [new]

Response

Parameters

Response 200application/json

Response 400application/json

Response 403application/json

Response 404application/json

Deploy API

Response

Parameters

Response 200application/json

Response 400application/json

Response 403application/json

Response 404application/json

Response 429application/json

Retrieve OpenAPI

Response

Parameters

Response 400application/json

Response 403application/json

Response 404application/json

Other responses

Retrieve Logs

Response

Parameters

Response 200application/json

Response 400application/json

Response 403application/json

Response 404application/json

Retrieve Log Events

Response

Parameters

Response 200application/json

Response 400application/json

Response 403application/json

Response 404application/json

Delete API

Response

Parameters

Response 400application/json

Response 403application/json

Response 404application/json

Response 429application/json

Other responses

Api Examples

Generate Subset

Request

Response

Request bodyapplication/json

Response 201application/json

Response 400application/json

Response 403application/json

Loans

Request body`application/json`

Response `201application/json`

Response `400application/json`

Response `403application/json`

Response `409application/json`

Response `422application/json`

`$input` Variable template examples

Example JSON mapping template using `$input`

Example mapping template using `$input`

Example request and response using `$input`

Request body`application/json`

Response `201application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `200application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `200application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `429application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `200application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `200application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `400application/json`

Response `403application/json`

Response `404application/json`

Response `429application/json`

Request body`application/json`

Response `201application/json`

Response `400application/json`

Response `403application/json`

Request body`application/json`

Response `201application/json`

Response `200application/json`

Response `403application/json`

Response `404application/json`

Response `200application/json`

Response `403application/json`

Response `404application/json`

Response `200application/json`

Response `404application/json`

Request body`application/json`

Response `201application/json`

Response `400application/json`

Response `409application/json`

Response `200application/json`

Response `404application/json`

Response `200multipart/form-data`

Request body`application/json`

Response `400application/json`

Request body`application/json`

Response `200application/json`

Response `400application/json`