Plan Basic
The basic plan provides a simple query on the requested document data.
| Params | Description |
|---|---|
| cpf | user document |
| name | user name |
| is_under_18 | Informs if the user is under 18 years old |
| status | document status in federal revenue |
| status_code | response code in federal revenue |
| date_death | date of death (if death is recorded) |
| is_pep | informs whether the user is a politically exposed person (PEP) |
| response_at | response date |
| response_token_validation | id responde |
Plan Standard
The standard plan provides a little more detail compared to the basic plan, such as: age and our internal monitoring in accordance with compliance rules.
| Params | Description |
|---|---|
| cpf | user document |
| name | user name |
| birth_date | date of birth of the document consulted |
| age | user age the document consulted |
| is_under_18 | Informs if the user is under 18 years old |
| status | document status in federal revenue |
| status_code | response code in federal revenue |
| date_death | date of death (if death is recorded) |
| is_pep | informs whether the user is a politically exposed person (PEP) |
| internal_status | Pay2free compliance monitoring status |
| internal_status_code | Pay2free compliance monitoring code |
| response_at | response date |
| response_token_validation | id responde |
How to identify internal_status and internal_status_code:
From the standard plan onwards, we will return exclusive Pay2free monitoring to you.
This monitoring includes real-time actions that are capable of identifying fraud and even classifying the user by risk (low, medium, high) to help you take action quickly and concisely.
| internal_status | internal_status_code |
|---|---|
| LISTA_RESTRITIVA | 1 |
| ANALISE_TRANSACIONAL | 2 |
| SUSPEITA_FRAUDE | 3 |
| ATIVO | 4 |
Plan Premium
The premium plan provides a variety of extremely important information for monitoring the reported document. As in the two previous plans, the query is made directly on the federal revenue database and in this case, we collect address information, employment relationships and banking information.
| Params | Description |
|---|---|
| cpf | user document |
| name | user name |
| birth_date | date of birth of the document consulted |
| age | user age the document consulted |
| is_under_18 | Informs if the user is under 18 years old |
| status | document status in federal revenue |
| status_code | response code in federal revenue |
| date_death | date of death (if death is recorded) |
| is_pep | informs whether the user is a politically exposed person (PEP) |
| internal_status | Pay2free compliance monitoring status |
| internal_status_code | Pay2free compliance monitoring code |
| mother_name | the name of the user's mother which document was searched |
| father_name | the name of the user's father which document was searched |
| address | will return an array containing the complete address of the queried document |
| employment | will return an array containing employment relationships |
| financial_info | Will return an array containing the bank accounts that the queried document has |
| response_at | response date |
| response_token_validation | id responde |
Plan Full
The full plan is our most robust plan. In addition to covering everything that exists in the other plans, the full plan will return the contact information of the researched document, family relationship, credit score, other related documents, risk mapping, PEP, negative media and other essential services for monitoring the your user.
| Params | Description |
|---|---|
| cpf | user document |
| name | user name |
| birth_date | date of birth of the document consulted |
| age | user age the document consulted |
| is_under_18 | Informs if the user is under 18 years old |
| status | document status in federal revenue |
| status_code | response code in federal revenue |
| date_death | date of death (if death is recorded) |
| is_pep | informs whether the user is a politically exposed person (PEP) |
| contacts_info | the list of related contacts that the consulted document has |
| family_members | the family members of the researched document such as: brother, grandparents... |
| mother_name | the name of the user's mother which document was searched |
| father_name | the name of the user's father which document was searched |
| credit_score | the credit line at the score level that the consulted document has |
| documents | other related documents |
| custom_risk_analysis | the risk analyzed and customized by the P2F compliance team, containing the risks (low, medium and high) |
| custom_info_compliance | investigates whether the researched document was mentioned in any negative media list, had pixmed, is associated with a sports association and among others... |
| internal_status | Pay2free compliance monitoring status |
| internal_status_code | Pay2free compliance monitoring code |
| address | will return an array containing the complete address of the queried document |
| employment | will return an array containing employment relationships |
| financial_info | Will return an array containing the bank accounts that the queried document has |
| response_at | response date |
| response_token_validation | id responde |