Contact Free trial Login

Blend Connector Reference

The main class of an extension, is the entry point from which configurations, connection providers, operations and sources are going to be declared.

Configurations


Config

Default configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Address

String

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.

Connection Types

Connection

This class (as its name implies) provides connection instances and the funcionality to disconnect and validate those connection. All connection related parameters (values required to create a connection) must be declared in the connection providers. This particular example is a PoolingConnectionProvider which declares that connection resolved by this provider will be pooled and reused. There are other implementations like CachedConnectionProvider which lazily creates and caches connection or simply ConnectionProvider if you want a new connection each time something requires one.

Parameters
Name Type Description Default Value Required

Username

String

x

Password

String

x

Use Persistent Connections Blend

Boolean

If false, each connection will be closed after the first request is completed.

true

Max Connections Blend

Number

The maximum number of outbound connection that will be kept open at the same time. By default the number of connection is unlimited.

-1

Connection Idle Timeout Blend

Number

The number of milliseconds that a connection can remain idle before it is closed. The value of this attribute is only used when persistent connection are enabled.

60000

Stream Response Blend

Boolean

Whether or not received responses should be streamed, meaning processing will continue as soon as all headers are parsed and the body streamed as it arrives. When enabled, the response MUST be eventually read since depending on the configured buffer size it may not fit into memory and processing will stop until space is available.

false

Response Buffer Size Blend

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

Connection Timeout Blend

Number

60000

Cache Control

String

no-cache

Blend API Version

String

2.1.0

Blend Deployment

String

blend-borrower

Blend Special Instance Id

String

apisero

TLS Configuration

TLS

Protocol to use for communication. Valid values are HTTP and HTTPS. Default value is HTTP. When using HTTPS the HTTP communication is going to be secured using TLS / SSL. If HTTPS was configured as protocol then the user needs to configure at least the keystore in the tls:context child element of this listener-config.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn't pass after exhausting the associated reconnection strategy

Operations

Delete a Borrower

<blend:delete-borrower>

Delete borrower from a specific loan.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Borrower Id

String

Borrower ID

x

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Get Disclosures Packages

<blend:get-disclosures-packages>

Retrieves status and metadata for all disclosures packages on a specific loan.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Loan Id

String

Loan id to filter disclosures packages by

x

Status

String

Disclosures package status to filter by

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Get Document Data

<blend:get-document-data>

Download the file associated with a document.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Document ID

String

Document ID

x

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Get Documents

<blend:get-documents>

Get a paginated list of documents.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Limit

String

The number of loans to be provided for this call. Minimum is 1, maximum is 100, default is 50.

Cursor

String

An opaque string used for pagination, pass the cursor back to start at this position

Exported

String

If exported is true, then the response only contains documents that have already been exported. If exported is false, then the response only contains documents that have not already been exported. Otherwise, the response returns documents independent of the exported field.

Include All Exports

String

If true, the losExportedAt time in the response will be that of the latest export (if one exists) by any paradigm. If false/not provided, the losExportedAt time in the response corresponds to the latest export (if one exists) by the paradigm of the current caller.

Uploaded After

String

Returns only documents uploaded after this time (UNIX milliseconds since epoch).

Uploaded Before

String

Returns only documents uploaded before this time (UNIX milliseconds since epoch).

Status Includes

String

Comma delimited string of document statuses to filter for.

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Get Export Statuses

<blend:get-export-status>

Get export statuses.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Loan Ids

String

Loan Ids to query for

x

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Get Borrower Pairs

<blend:get-loan-application-details>

Get the list of borrower pairs on the loan (relevant for mortgage loans).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Loan Id

String

Loan ID

x

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Get Loan Borrowers

<blend:get-loan-borrowers>

Get a list of borrowers on the loan.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Loan Id

String

Loan id

x

Los Id Eq

String

Returns only the borrower matching the given LOS identifier, if they exist on this loan

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Get Loan Data

<blend:get-loan-data>

Get loan details in JSON, MISMO 3.3.1, or Fannie 3.2 format. The MISMO 3.3.1 and Fannie 3.2 responses are base64 encoded and contain more details about the loan than the JSON response does.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Loan Id

String

Loan ID

x

Format

String

Response format

Version

String

There is no version requirement for json. Fannie version must be 3.2. MISMO version must be 3.3.1.

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Get Loan Documents

<blend:get-loan-documents>

Get a list of all the uploaded and signature complete documents on a specific loan, ordered by document creation date.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Loan Id

String

Loan ID

x

Include All Documents

String

If true, returns a list of all the documents on the loan, including signature pending documents.

Include All Exports

String

If true, the los exported at time in the response will be that of the latest export (if one exists) by any paradigm. If false/not provided, the losExportedAt time in the response will correspond to the latest export (if one exists) by the paradigm of the current caller.

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Get Active Loans

<blend:get-loans>

Get a paginated list of active loans sorted by creation date descending. This endpoint also supports a few filtering parameters.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Limit

String

The number of loans to be provided for this call. Minimum is 1, maximum is 100, default is 50.

Cursor

String

An opaque string used for pagination, pass the cursor back to start at this position.

Los Id Exists

String

If losIdExists is true, then the response only contains loans that have losId set. If losIdExists is false, then the response only contains loans that do not have losId set. Otherwise, the response returns loans independent of the losId field.

Crm Id EQ

String

Filters the list of loans to loans that have the same crmId.

Borrower Email EQ

String

Filters the list of loans to loans that have the same borrower email.

Los Id EQ

String

Filters the list of loans to loans that have the same losId.

Exportable

String

If exportable is true, then the response contains the list of loans that can be exported (e.g. borrower submitted, lender clicks export, or trid is triggered). If exportable is false, then the response contains the list of loans that cannot be exported. If omitted, the response returns loans independent of exportable field.

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Update a Borrower

<blend:patch-borrower>

Update a borrower's details.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Borrower Id

String

Borrower ID

x

Patch Borrower Body

Object

Borrower update parameters

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Update Loan Properties

<blend:patch-loan>

Update properties on a specific loan.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Loan Id

String

Loan id

x

Patch Loan Body

Object

Loan update body

#[payload]

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Create a Borrower

<blend:post-borrower>

Add a borrower to a specific loan. You can only add non-primary borrowers through this endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Post Borrower Body

Object

Borrower parameters

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Create a Document

<blend:post-document>

Create a document on a specific loan with a file and related metadata.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Documents Body

Binary

Document request schema

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Update Loan Export Status

<blend:post-export-status>

Update export status on a loan.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Loan Id

String

Loan ID

x

Body

Object

Export status and reason for that status.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Create a Loan

<blend:post-loan>

This endpoint is usually used to create loans in Blend, from CRMs or other central borrower databases, with minimal borrower and loan data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Loan Body

Object

Loan creation request body.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Bulk Update Los Milestones

<blend:post-los-milestones>

Bulk update a list of loans to be on specific los milestones.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Los Milestones Body

Object

List of loan IDs and the milestones to update to.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Add a Realtor

<blend:post-realtor>

Add realtor to loan.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Post Realtor Body

Object

Realtor request schema

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Update Loan Borrowers Location

<blend:put-loan-application-details>

Update the location of borrowers on the loan (by 1003/borrower pairing and location on the borrower pair).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Loan Id

String

Loan ID

x

Put Loan Application Details Body

Object

New borrower pair

#[payload]

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

For Configurations

Throws

  • BLEND:NOT_FOUND

  • BLEND:UNAUTHORIZED

  • BLEND:FORBIDDEN

  • BLEND:RETRY_EXHAUSTED

  • BLEND:SERVICE_UNAVAILABLE

  • BLEND:NOT_ACCEPTABLE

  • BLEND:BAD_GATEWAY

  • BLEND:UN_PROCESSABLE_ENTITY

  • BLEND:INTERNAL_SERVER_ERROR

  • BLEND:METHOD_NOT_ALLOWED

  • BLEND:GENERIC_EXCEPTION

  • BLEND:NOT_IMPLEMENTED

  • BLEND:CONNECTIVITY

  • BLEND:EMPTY_HEAD_COUNT

  • BLEND:CONFLICT

  • BLEND:BAD_REQUEST

  • BLEND:DEAD_TOKEN

  • BLEND:REQUEST_TIMEOUT

Types

TLS

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer CRLs

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Response Status

Field Type Description Default Value Required

Headers

Object

Status Code

Number

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.