Loan Tapes

Allows investors to get different loan tapes delivered to different SFTP servers.

Create loan tape

Creates a new loan tape.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Request Body schema: application/json
investorId
string or null

The investor ID.

loanTapeTypeId
required
string

The loan tape type ID.

sftpHostname
required
string

The hostname for SFTP. Host name should not contain a scheme, so don't put sftp:// on the front. You may optionally specify a port like so: example.com:222. If no port is supplied a default of 22 will be used.

sftpUsername
required
string

The username for SFTP.

sftpPassword
required
string

The password for SFTP.

sftpCdDir
string or null

Change directory into this folder before performing the upload.

uploadFrequency
required
string

The loan tape upload frequency.

Enum: "daily" "weekly" "monthly"
encryptionMethod
string or null

The encryption method that Peach system with use to encrypt the files.

Value: "GPG"
publicKey
string or null

The lender's public key to use to encrypt the files. A value must be passed if encryptionMethod is set.

specificDays
Array of numbers or null <integer>

Specific days designates the day(s) when to upload the loan tape. The allowed values for specific day(s) depends on the uploadFrequency.

weekly - provide one number in the valid range 1-7. 1=Monday...7=Sunday.

For example: [1].

monthly - provide one number in the valid range 1-31. 1=first day of a month. Use 31 to indicate the last day of a month.

For example: [1].

Leave null if uploadFrequency is daily. Otherwise, a value must be passed.

Responses
200

Success

post/companies/{companyId}/loan-tapes
Request samples
application/json
{
  • "investorId": "string",
  • "loanTapeTypeId": "string",
  • "sftpHostname": "string",
  • "sftpUsername": "string",
  • "sftpPassword": "string",
  • "sftpCdDir": "string",
  • "uploadFrequency": "daily",
  • "encryptionMethod": "GPG",
  • "publicKey": "string",
  • "specificDays": [
    ]
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get loan tapes

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

query Parameters
untokenize
boolean
Default: false

Untokenize any tokenized fields if the calling user has the applicable permission.

limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

Responses
200

Success

get/companies/{companyId}/loan-tapes
Response samples
application/json
{
  • "count": 0,
  • "data": [
    ]
}

Get loan tape by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTapeId
required
string

The ID of the loan tape

query Parameters
untokenize
boolean
Default: false

Untokenize any tokenized fields if the calling user has the applicable permission.

Responses
200

Success

get/companies/{companyId}/loan-tapes/{loanTapeId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update loan tape

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTapeId
required
string

The ID of the loan tape

Request Body schema: application/json
investorId
string or null

The investor ID.

loanTapeTypeId
string

The loan tape type ID.

sftpHostname
string

The hostname for SFTP. Host name should not contain a scheme, so don't put sftp:// on the front. You may optionally specify a port like so: example.com:222. If no port is supplied a default of 22 will be used.

sftpUsername
string

The username for SFTP.

sftpPassword
string

The password for SFTP.

sftpCdDir
string or null

Change directory into this folder before performing the upload.

uploadFrequency
string

The loan tape upload frequency.

Enum: "daily" "weekly" "monthly"
encryptionMethod
string or null

The encryption method that Peach system with use to encrypt the files.

Value: "GPG"
publicKey
string or null

The lender's public key to use to encrypt the files. A value must be passed if encryptionMethod is set.

specificDays
Array of numbers or null <integer>

Specific days designates the day(s) when to upload the loan tape. The allowed values for specific day(s) depends on the uploadFrequency.

weekly - provide one number in the valid range 1-7. 1=Monday...7=Sunday.

For example: [1].

monthly - provide one number in the valid range 1-31. 1=first day of a month. Use 31 to indicate the last day of a month.

For example: [1].

Leave null if uploadFrequency is daily. Otherwise, a value must be passed.

Responses
200

Success

put/companies/{companyId}/loan-tapes/{loanTapeId}
Request samples
application/json
{
  • "investorId": "string",
  • "loanTapeTypeId": "string",
  • "sftpHostname": "string",
  • "sftpUsername": "string",
  • "sftpPassword": "string",
  • "sftpCdDir": "string",
  • "uploadFrequency": "daily",
  • "encryptionMethod": "GPG",
  • "publicKey": "string",
  • "specificDays": [
    ]
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Delete loan tape

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

loanTapeId
required
string

The ID of the loan tape

Responses
204

Success

delete/companies/{companyId}/loan-tapes/{loanTapeId}