logo

Identity

Creating an identity establishes a unique identification for people associated with your business. Accurately providing your information is crucial in ensuring that your identity is properly verified and maintained, and can have important consequences for a variety of financial and legal transactions. Our platform has a secure database for storing identity information, encryption and other security measures to protect your sensitive data.

Create an Identity

Create an Identity

Request
header Parameters
Authorization
required
string

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Example: Bearer {access_token}
Request Body schema: application/json
required
name
string

legal name

title
string

job title

email
string

email address

phone
string

phone number

dob_day
string

two-digit birth day

dob_month
string

two-digit birth month

dob_year
string

four-digit birth year (must be at least 18 years old)

identification_number
string

full social security number

is_owner
boolean

if an identity owns 25% or more of the business, they are considered an owner

object

any useful information you'd like to store alongside this identity

Address (object) or object
Responses
201

Identity was created successfully

post/entities/identity
Request samples
application/json
{
  • "name": "Person Name",
  • "title": "President",
  • "email": "person.name@justifi.ai",
  • "phone": "6124011111",
  • "dob_day": "01",
  • "dob_month": "01",
  • "dob_year": "1980",
  • "identification_number": "123456789",
  • "is_owner": true,
  • "metadata": {
    },
  • "address": {
    }
}
Response samples
application/json
{
  • "id": 1,
  • "type": "identity",
  • "data": {
    },
  • "page_info": "string"
}

List Identities

List identities for your platform. This endpoint supports pagination.

Request
header Parameters
Authorization
required
string

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Example: Bearer {access_token}
Responses
200

Successfully list identities

get/entities/identity
Request samples 
Response samples 
application/json
{
  • "id": 1,
  • "type": "array",
  • "data": [
    ],
  • "page_info": {
    }
}
Update an Identity
Update information about an Identity


Request 
path Parameters
id
required
string <uuid> 
 
header Parameters
Authorization
required
string
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)


 
 Example:  Bearer {access_token}
Request Body schema: application/json
required
name
string
legal name


 
title
string
job title


 
email
string
email address


 
phone
string
phone number


 
dob_day
string
two-digit birth day


 
dob_month
string
two-digit birth month


 
dob_year
string
four-digit birth year (must be at least 18 years old)


 
identification_number
string
full social security number


 
is_owner
boolean
if an identity owns 25% or more of the business, they are considered an owner


 
object
any useful information you'd like to store alongside this identity


 
Responses 
200
Identity updated


patch/entities/identity/{id}
Request samples 
application/json
{
  • "name": "Person Name",
  • "title": "President",
  • "email": "person.name@justifi.ai",
  • "phone": "6124011111",
  • "dob_day": "01",
  • "dob_month": "01",
  • "dob_year": "1980",
  • "identification_number": "123456789",
  • "is_owner": true,
  • "metadata": {
    }
}
Response samples 
application/json
{
  • "id": 1,
  • "type": "identity",
  • "data": {
    },
  • "page_info": "string"
}
Get an Identity
Get information about an Identity


Request 
path Parameters
id
required
string <uuid> 
 
header Parameters
Authorization
required
string
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)


 
 Example:  Bearer {access_token}
Responses 
200
Get Identity


get/entities/identity/{id}
Request samples 
Response samples 
application/json
{
  • "id": 1,
  • "type": "identity",
  • "data": {
    },
  • "page_info": "string"
}
➔ Next to Address