You are viewing the latest API docs through the legacy docs viewer. The modern viewer can be found here: https://docs.peachfinance.com/api-docs.
Peach Finance

Identity

Identity objects represent various forms of identification that a borrower may have. We allow one primary identity per borrower, and any number of secondary identities. The identity sent when creating a borrower is the primary identity, and cannot be deleted/archived or changed to be a secondary identity.

Get primary identity

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.

Responses
200

Success

get/people/{personId}/identity
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get identities

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.

query Parameters
includeArchived
boolean
Default: false

If set to true, includes archived identities

Responses
200

Success

get/people/{personId}/identities
Response samples
application/json
{
  • "status": 0,
  • "count": 0,
  • "data": [
    ]
}

Create identity

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.

Request Body schema: application/json
required
identityType
required
string

Personal and business identifiers that are supported. customID can be used for personal or business IDs that are not explicitly listed as one of the enum values. If you pass identityType=customID, a customIdentityTypeName is also required.

For example: Metrica Consular Card for Mexicans living abroad.

  • identityType=customID
  • customIdentityTypeName=metricaConsularCard
Enum: "SSN" "ITIN" "passport" "driversLicense" "taxID" "FEIN" "stateID" "customID"
customIdentityTypeName
string [ 1 .. 50 ] characters ^[a-zA-Z]+$

The name of a personal or business ID. Required if identityType=customID. This needs to be "one word" only US (a-zA-Z) letters. No numbers.

For example: Metrica Consular Card for Mexicans living abroad.

  • identityType=customID
  • customIdentityTypeName=metricaConsularCard
value
required
string

The value of a personal identifier. For example, 123456789.

valid
boolean
Default: true

Whether the identity is valid.

issueDate
string or null <date>

Date the identification was issued.

expirationDate
string or null <date>

Date the identification expires.

issuingCountry
string
Default: ""

Country that issued the identification. English short name according to ISO 3166-1 standard.

isArchived
boolean

Determines whether the identity has been archived. By default, only non-archived identities are shown. Cannot be changed for primary identities.

isPrimary
boolean
Default: false

Whether the identity is the borrower's primary identity or not. A borrower may only have one primary identity. Primary identities can be created when creating a borrower, or separately.

caseId
string

An identifier for an existing case.

Responses
200

Success

post/people/{personId}/identities
Request samples
application/json
{
  • "identityType": "SSN",
  • "customIdentityTypeName": "string",
  • "value": "string",
  • "valid": true,
  • "issueDate": "2019-08-24",
  • "expirationDate": "2019-08-24",
  • "issuingCountry": "",
  • "isArchived": true,
  • "isPrimary": false,
  • "caseId": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get identity by ID

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.

personIdentityId
required
string

An identity's unique identifier.

Responses
200

Success

get/people/{personId}/identities/{personIdentityId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update identity

For primary identities, the isArchived field cannot be changed.

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.

personIdentityId
required
string

An identity's unique identifier.

Request Body schema: application/json
required
identityType
string

Personal and business identifiers that are supported. customID can be used for personal or business IDs that are not explicitly listed as one of the enum values. If you pass identityType=customID, a customIdentityTypeName is also required.

For example: Metrica Consular Card for Mexicans living abroad.

  • identityType=customID
  • customIdentityTypeName=metricaConsularCard
Enum: "SSN" "ITIN" "passport" "driversLicense" "taxID" "FEIN" "stateID" "customID"
customIdentityTypeName
string [ 1 .. 50 ] characters ^[a-zA-Z]+$

The name of a personal or business ID. Required if identityType=customID. This needs to be "one word" only US (a-zA-Z) letters. No numbers.

For example: Metrica Consular Card for Mexicans living abroad.

  • identityType=customID
  • customIdentityTypeName=metricaConsularCard
value
string

The value of a personal identifier. For example, 123456789.

valid
boolean
Default: true

Whether the identity is valid.

issueDate
string or null <date>

Date the identification was issued.

expirationDate
string or null <date>

Date the identification expires.

issuingCountry
string
Default: ""

Country that issued the identification. English short name according to ISO 3166-1 standard.

isArchived
boolean

Determines whether the identity has been archived. By default, only non-archived identities are shown. Cannot be changed for primary identities.

caseId
string

An identifier for an existing case.

Responses
200

Success

put/people/{personId}/identities/{personIdentityId}
Request samples
application/json
{
  • "identityType": "SSN",
  • "customIdentityTypeName": "string",
  • "value": "string",
  • "valid": true,
  • "issueDate": "2019-08-24",
  • "expirationDate": "2019-08-24",
  • "issuingCountry": "",
  • "isArchived": true,
  • "caseId": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Archive identity

Primary identities cannot be archived.

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.

personIdentityId
required
string

An identity's unique identifier.

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

Optional case ID to be recorded with the change.

Responses
204

No content

delete/people/{personId}/identities/{personIdentityId}
➔ Next to Contact Information

Request sandbox access