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^ext-|^[A-Z]{2}-[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^ext-|^[A-Z]{2}-[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
{
  • "count": 0,
  • "data": [
    ]
}

Create identity

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string^ext-|^[A-Z]{2}-[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
identityType
required
string

Personal and business identifiers that we support. For business use FEIN.

Enum: "SSN" "ITIN" "passport" "driversLicense" "taxID" "FEIN"
value
required
string

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

valid
boolean
Default: true

Whether or not 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 or not 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",
  • "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^ext-|^[A-Z]{2}-[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^ext-|^[A-Z]{2}-[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
identityType
string

Personal and business identifiers that we support. For business use FEIN.

Enum: "SSN" "ITIN" "passport" "driversLicense" "taxID" "FEIN"
value
string

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

valid
boolean
Default: true

Whether or not 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 or not 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",
  • "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^ext-|^[A-Z]{2}-[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^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

Optional case ID to be recorded with the change.

Responses
204

Success no content

delete/people/{personId}/identities/{personIdentityId}