Peach Finance

Credit Agencies

Create credit agency

Creates a new credit agency.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

Request Body schema: application/json
required
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
agencyName
required
string (AgencyName)

The credit agency name.

Enum: "experian" "equifax" "transUnion" "innovis"
country
required
string <= 2 characters

The credit agency country.

dataFormat
required
string

The format of the reported data and file.

Value: "metro2"
nameFilePerAgencyConvention
boolean
Default: true

If true Peach system will name the file based on the credit agency convention.

Equifax: Company legal name + Company ID + Credit agency name + today's date YYYYMMDD + .txt. For example: PEACHFINANCEINCCPYL69X5Z1EQUIFAX20211021.txt.

Experian: fileNamePrefix + . + today's date MMDDYYYY + .txt. For example: MKFRT.10262021.txt.

TransUnion: Company legal name + Company ID + Credit agency name + today's date YYYYMMDD + .txt. For example: PEACHFINANCEINCCPYL69X5Z1TRANSUNION20211213.txt.

If false Peach system will name the file as: Company legal name + Company ID + Credit agency name + today's date YYYYMMDD + .txt For example: PEACHFINANCEINCCPYL69X5Z1EXPERIAN20211021.txt

fileNamePrefix
string

The file name prefix. Must be provided if agencyName=experian and nameFilePerAgencyConvention=true. Only used if agencyName=experian and nameFilePerAgencyConvention=true.

isPeachAggregator
boolean
Default: false

DEPRECATED ATTRIBUTE

This field is deprecated, and is only included to remain backward compatible. Only send false.

sftpAccessMethod
string
Default: "usernamePassword"

If usernamePassword, then sftpUsername and sftpPassword must be provided.

If keys, then sftpSSHPeachPrivateKey and sftpSSHPeachPublicKey will be created by peach.

Enum: "usernamePassword" "keys"
sftpHostname
string or null

The SFTP hostname. If SFTP hostname, username, and password are set, they will be used instead of the default credit bureau credentials. 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 or null

The username for SFTP.

sftpPassword
string or null

The password for SFTP.

sftpCdDir
string

Change directory into this folder before performing the upload.

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.

uploadFrequency
string

The credit reporting file creation frequency. Only monthly is currently supported.

Value: "monthly"
specificDays
Array of integers

Specific days designate the day(s) when to upload the credit reporting file. Only the 1st day of the month is currently supported.

The allowed values for specific day(s) depends on the uploadFrequency. 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].

useLoanExternalId
boolean
Default: true

Indicates what identifier to use as an account identifier for credit reporting.

If true, the system will use loan externalId as an account identifier for credit reporting. If externalId doesn't exist the system will use loan Peach Public ID.

If false, the system will use loan Peach Public ID (e.g. LN-JFU3-ER3S) as an account identifier for credit reporting.

enrollExistingLoans
boolean
Default: false

Automatically enroll existing active loans for credit reporting with this agency.

copyKeysFrom
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

Peach's unique or lender's external identifier.

Responses
200

Success

post/companies/{companyId}/credit-agencies
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "agencyName": "experian",
  • "country": "st",
  • "dataFormat": "metro2",
  • "nameFilePerAgencyConvention": true,
  • "fileNamePrefix": "string",
  • "isPeachAggregator": false,
  • "sftpAccessMethod": "usernamePassword",
  • "sftpHostname": "string",
  • "sftpUsername": "string",
  • "sftpPassword": "string",
  • "sftpCdDir": "string",
  • "encryptionMethod": "GPG",
  • "publicKey": "string",
  • "uploadFrequency": "monthly",
  • "specificDays": [
    ],
  • "useLoanExternalId": true,
  • "enrollExistingLoans": false,
  • "copyKeysFrom": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get credit agencies

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

query Parameters
uploadedByLender
boolean

If true, only returns Credit Agency objects that have the SFTP credentials filled in, meaning the lender will upload the file to the credit agency.

If false, only returns Credit Agency objects that have the SFTP credentials empty, meaning Peach will upload the file to the credit agency.

If not set, includes all.

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}/credit-agencies
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": [
    ]
}

Get credit agency by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

creditAgencyId
required
string

The ID of the credit agency

Responses
200

Success

get/companies/{companyId}/credit-agencies/{creditAgencyId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update credit agency

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
companyId
required
string

The unique company identifier.

creditAgencyId
required
string

The ID of the credit agency

Request Body schema: application/json
required
id
string
createdAt
string <date-time>
updatedAt
string or null <date-time>
deletedAt
string or null <date-time>
agencyName
string (AgencyName)

The credit agency name.

Enum: "experian" "equifax" "transUnion" "innovis"
country
string <= 2 characters

The credit agency country.

dataFormat
string

The format of the reported data and file.

Value: "metro2"
nameFilePerAgencyConvention
boolean
Default: true

If true Peach system will name the file based on the credit agency convention.

Equifax: Company legal name + Company ID + Credit agency name + today's date YYYYMMDD + .txt. For example: PEACHFINANCEINCCPYL69X5Z1EQUIFAX20211021.txt.

Experian: fileNamePrefix + . + today's date MMDDYYYY + .txt. For example: MKFRT.10262021.txt.

TransUnion: Company legal name + Company ID + Credit agency name + today's date YYYYMMDD + .txt. For example: PEACHFINANCEINCCPYL69X5Z1TRANSUNION20211213.txt.

If false Peach system will name the file as: Company legal name + Company ID + Credit agency name + today's date YYYYMMDD + .txt For example: PEACHFINANCEINCCPYL69X5Z1EXPERIAN20211021.txt

fileNamePrefix
string

The file name prefix. Must be provided if agencyName=experian and nameFilePerAgencyConvention=true. Only used if agencyName=experian and nameFilePerAgencyConvention=true.

isPeachAggregator
boolean
Default: false

DEPRECATED ATTRIBUTE

This field is deprecated, and is only included to remain backward compatible. Only send false.

sftpAccessMethod
string
Default: "usernamePassword"

If usernamePassword, then sftpUsername and sftpPassword must be provided.

If keys, then sftpSSHPeachPrivateKey and sftpSSHPeachPublicKey will be created by peach.

Enum: "usernamePassword" "keys"
sftpHostname
string or null

The SFTP hostname. If SFTP hostname, username, and password are set, they will be used instead of the default credit bureau credentials. 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 or null

The username for SFTP.

sftpPassword
string or null

The password for SFTP.

sftpCdDir
string

Change directory into this folder before performing the upload.

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.

uploadFrequency
string

The credit reporting file creation frequency. Only monthly is currently supported.

Value: "monthly"
specificDays
Array of integers

Specific days designate the day(s) when to upload the credit reporting file. Only the 1st day of the month is currently supported.

The allowed values for specific day(s) depends on the uploadFrequency. 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].

useLoanExternalId
boolean
Default: true

Indicates what identifier to use as an account identifier for credit reporting.

If true, the system will use loan externalId as an account identifier for credit reporting. If externalId doesn't exist the system will use loan Peach Public ID.

If false, the system will use loan Peach Public ID (e.g. LN-JFU3-ER3S) as an account identifier for credit reporting.

Responses
200

Success

put/companies/{companyId}/credit-agencies/{creditAgencyId}
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "agencyName": "experian",
  • "country": "st",
  • "dataFormat": "metro2",
  • "nameFilePerAgencyConvention": true,
  • "fileNamePrefix": "string",
  • "isPeachAggregator": false,
  • "sftpAccessMethod": "usernamePassword",
  • "sftpHostname": "string",
  • "sftpUsername": "string",
  • "sftpPassword": "string",
  • "sftpCdDir": "string",
  • "encryptionMethod": "GPG",
  • "publicKey": "string",
  • "uploadFrequency": "monthly",
  • "specificDays": [
    ],
  • "useLoanExternalId": true
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}
➔ Next to Collection Agencies