Create a person on a loan

Request

Create a person and attach them to the loan with the given role. Accepts a full SSN; only the last 4 digits are ever returned.

Security

ApiKeyAuth

Path

idstringrequired

Idempotency-Keystring, <= 255 characters

Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect.

Bodyapplication/jsonrequired

firstNamestring, non-emptyrequired

lastNamestring, non-emptyrequired

rolestring, non-emptyrequired

Entity-in-loan role name, e.g. "borrower" or "guarantor" (resolved server-side; unknown names return 400). See the roles echoed by GET /loans/:id/entities.

ssnstring

emailstring, (email)^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-...

dobstring^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[...

curl -i -X POST \
  'https://api.pioneerft.com/api/public/v1/loans/{id}/people' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -d '{
    "firstName": "string",
    "lastName": "string",
    "ssn": "string",
    "email": "user@example.com",
    "dob": "string",
    "role": "string"
  }'

Responses

Person created

Bodyapplication/json

dataobject(PublicPerson)

Response

{
  "data": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "ssnLast4": "string",
    "role": "string",
    "ownershipPercent": 0
  }
}