Customer (OFPI) Model and States
Reference information regarding the Customer resource (Payments Brazil).
A Customer in OFPI is the user who you request funds from or send funds to.
Customer Model
{
"id": "7c2be016-37e3-44e2-8643-db2eb1129a3f",
"created_at": "2022-02-09T08:45:50.406032Z",
"created_by": "417514fe-50f6-42e9-a3eb-c71da00f014c",
"customer_type": "INDIVIDUAL",
"name": "Caetano Veloso",
"country": "BRA",
"email": "[email protected]",
"identifier": "23******00",
"identifier_type": "CPF",
"address": "Rua de Caetano Veloso 432, 70200 Brasilia",
"phone": "3210-9876"
}
Parameter | Type | Description | Example |
---|---|---|---|
id | string | Belvo's unique identifier for the current customer. | 7c2be016-37e3-44e2-8643-db2eb1129a3f |
created_at | string | The ISO-8601 timestamp of when the data point was created in Belvo's database. | 2022-02-09T08:45:50.406032Z |
created_by | string | The unique ID for the user that created this item. | 417514fe-50f6-42e9-a3eb-c71da00f014c |
customer_type | string | The type of customer. Can be either: INDIVIDUAL or BUSINESS . | INDIVIDUAL |
name | string | The full name of the customer. | Gustavo Veloso |
country | string | The customer's country of residence. | BRA |
email | string | The customer's email address. | [email protected] |
identifier | string | The document number of the customer's ID (depending on the identifier_type ).> Note: This value is masked. | 23******00 |
identifier_type | string | The customer's ID document type. For Brazil, this can be either: CPF or CNPJ . | CPF |
address | string | The customers physical address. | Rua de Caetano Veloso 432, 70200 Brasilia |
phone | string | The customer's phone number. | 3210-9876 |
Updated 28 days ago