Profile
Discover the personal information we retrieve from Formal Economy integrations.
Definition
The profile of a formal economy account contains basic personal information that can complement your onboarding or security processes.
You can access the profile of an account via the GET profile endpoint .
Profile Information for Formal Economy Accounts
Let's begin with a representative example of the profile information you could recover from our GET Profile Endpoint:
{
"success": true,
"error": null,
"data": {
"account_id": "3869ce98-fa81-4183-bb2a-d1ecff0c18ba",
"external_id": null,
"profile": {
"first_name": "Johann",
"last_name": "Sebastian Bach",
"email": null,
"birthday": "1985-03-31"
},
"ids_info": [
{
"type": "social_security_number",
"name": "nss",
"value": "10140050215"
}
]
}
}
Profile Section Data Dictionary
In the example above we can see there is a profile
object with the following fields:
Field Name | Type | Nullable | Example |
---|---|---|---|
first_name | string | true | Jose Carlos |
last_name | string | true | Huerta Garcia |
string | true | [email protected] | |
birthday | string | true | 1990-01-01 |
IDs Info Section Data Dictionary
In the example above we can see there is an ids_info
object with the following fields:
Data | Description | Type | Example |
---|---|---|---|
type | ID Type | string | social_security_number |
name | API Code for this ID Type | string | nss |
value | The specific value of this credential | string | 32128929096 |
Disclaimer
The previous representative example shows the profile information we recover most of the time for Formal Economy Platforms. However, our dependency on external integrations prevents us from guaranteeing our clients we will recover all of it every single time.
Updated 3 days ago