Credit Reporting

This object represents loan credit reporting data as it was reported to credit bureaus.

Start credit reporting

Sets the starting date to begin reporting credit history for the loan.

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

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

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external 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>
creditAgencyId
required
string

The unique credit agency identifier.

reportingStartDate
required
string <date>

When a new loan is created the system automatically starts reporting to all agencies that are configured in the loan type configuration. In that case the reportingStartDate will be equal to the loan’s activatedAt date.

When an existing loans (aka loan in flight) needs to be reported, the reportingStartDate indicates how much of the loan's history should be reported. If a full history needs to be reported, set the reportingStartDate to be equal to loan's activatedAt date.

Responses
200

Success

post/people/{personId}/loans/{loanId}/credit-reporting
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "creditAgencyId": "string",
  • "reportingStartDate": "2019-08-24"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update reporting fields

Sets loan-level credit reporting fields

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

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

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

Request Body schema: application/json
required
object
Responses
200

Success

put/people/{personId}/loans/{loanId}/credit-reporting
Request samples
application/json
{
  • "metro2": {
    }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get credit reporting statuses

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

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

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

Responses
200

Success

get/people/{personId}/loans/{loanId}/credit-reporting
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": {
    }
}

Delete from credit reporting

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

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

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external 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>
deletedReason
required
string

The reason why the loan was stopped from being reported.

Enum: "legal" "fcraDispute" "loanDataCorrupted" "other"
deletedReasonDetails
string

Additional details about why the loan was stopped from being reported.

caseId
string or null

An identifier for an existing case.

object (LoanCancelMetro2RequestBody)
Responses
200

Success

post/people/{personId}/loans/{loanId}/credit-reporting/{creditAgencyId}/delete
Request samples
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "deletedReason": "legal",
  • "deletedReasonDetails": "string",
  • "caseId": "string",
  • "metro2": {
    }
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}