Identity
List Identities
List identities for your platform. This endpoint supports pagination.
get/entities/identity
Request
- Base URLhttps://api.justifi.ai/v1
- Authnone declared. Required headers: Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
Authorizationstring required
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)
Response
Successfully list identities
Example response
{
"id": 1,
"type": "array",
"data": [
{
"id": "idty_xyz",
"platform_account_id": "acc_xyz",
"business_id": "biz_xyz",
"name": "Person Name",
"title": "President",
"email": "person.name@justifi.ai",
"phone": "6124011111",
"dob_day": "01",
"dob_month": "01",
"dob_year": "1980",
"ssn_last4": "6789",
"is_owner": true,
"ownership_percentage": 25,
"address": {
"id": "addr_123xyz",
"platform_account_id": "acc_123xyz",
"line1": "123 Example St",
"line2": "Suite 101",
"city": "Minneapolis",
"state": "MN",
"postal_code": "55555",
"country": "USA",
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
},
"documents": [
{
"id": "doc_abc123",
"platform_account_id": "acc_123xyz",
"description": "My Document",
"file_name": "my_document",
"file_type": "pdf",
"document_type": "balance_sheet",
"business_id": "biz_abc123",
"identity_id": "idty_abc123",
"presigned_url": "https://test.test/doc_abc123/file_name.pdf",
"metadata": {
"language": "english",
"social_network": "@person"
},
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
}
],
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
}
],
"page_info": {
"end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd",
"start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.