Através dessa consulta você pode listar todas as contas com filtros expecificos.
Utilize uma requisição do tipo GET, utilizando o endpoint /Company/onboardings.
Exemplo:
https://example.com/company/onboardings
Atenção
Você deve informar o TOKEN de acesso no HEADER da requisição. Para saber mais sobre o token de acesso, consulte Login.
Filtros
Você pode utilizar filtros para ajudar a encontrar o resultado desejado.
- Status
- Documento
- Criado a partir de
- Criado até
- Quantidade
- Paginação
Resposta da requisição
[
{
"parent_key": "string",
"key": "string",
"company_id": 0,
"target_company_id": 0,
"phone_number": "string",
"cpf": "string",
"cnpj": "string",
"status": 1,
"created_at": "2024-11-13T22:10:40.240Z",
"customer_id": 0,
"type": 1,
"email": "string",
"name": "string",
"selfie_url": "string",
"next_update_at": "2024-11-13T22:10:40.240Z",
"updated_at": "2024-11-13T22:10:40.240Z",
"reproval_reasons": "string",
"additional_data": "string",
"description": "string",
"contract_type": "string",
"linked": true,
"documents": [
{
"back_image_url": "string",
"front_image_url": "string",
"type": 1,
"document": "string",
"created_at": "2024-11-13T22:10:40.240Z"
}
],
"tags": [
"string"
],
"addresses": [
{
"postal_code": "string",
"federative_unit": "string",
"city": "string",
"street": "string",
"street_number": "string",
"street_complement": "string",
"neighborhood": "string",
"created_at": "2024-11-13T22:10:40.240Z"
}
],
"customer": {
"customer_id": 0,
"profile": 1,
"company_id": 0,
"social_name": "string",
"first_name": "string",
"last_name": "string",
"email": "string",
"telephone": "string",
"salary": 0,
"total_limit": 0,
"is_active": true,
"signed_term": true,
"debit": 0,
"document": "string",
"newsletter": true,
"date_added": "2024-11-13T22:10:40.240Z",
"birth_date": "2024-11-13T22:10:40.240Z",
"deactivation_date": "2024-11-13T22:10:40.240Z",
"marital_status": 0,
"capabilities": "string",
"onboarding_status": 1,
"onboarding_required": true,
"company": {
"accountable": "string",
"closing_day": 0,
"cnpj": "string",
"cpf": "string",
"celcoin_account": "string",
"is_politically_exposed_person": true,
"accountable_mother_name": "string",
"accountable_birth_date": "2024-11-13T22:10:40.240Z",
"document": "string",
"raw_document": "string",
"account_cpf": "string",
"company_id": 0,
"contact": "string",
"email": "string",
"social_reason": "string",
"social_name": "string",
"fantasy_name": "string",
"month_installment_limit": 0,
"phone": "string",
"webhook_url": "string",
"transfer_fee": 0,
"internal_transfer_fee": 0,
"linked_account_fee": 0,
"accountable_cpf": "string",
"accountable_cnpj": "string",
"accountable_type": 1,
"zipcode": "string",
"street": "string",
"street_number": "string",
"street_complement": "string",
"neighborhood": "string",
"state": "string",
"city": "string",
"financially_blocked": true,
"date_added": "2024-11-13T22:10:40.240Z",
"founding_date": "2024-11-13T22:10:40.240Z",
"settled_pix_invoice_fee": 0,
"cash_in_fixed_fee": 0,
"cash_in_proportional_fee": 0,
"pix_cash_in_key": "string",
"movement_awaiting_balance_enabled": true,
"allowed_order_cron": "string",
"consignation_enabled": true,
"big_data_status": 0,
"consignable_mode": 0,
"max_transfer_cash_out": 0,
"max_payment_cash_out": 0,
"default_pix_key": "string",
"company_type": "string",
"balance": 0,
"swap_account": {
"status": 0,
"individual_id": "string",
"business_id": "string",
"account_holder_id": "string",
"balance_account_group_id": "string",
"balance_account_group_created_at": "2024-11-13T22:10:40.240Z",
"updated_at": "2024-11-13T22:10:40.240Z",
"branch": "string",
"account": 0
},
"actual_closing_date": "2024-11-13T22:10:40.240Z",
"last_closing_date": "2024-11-13T22:10:40.240Z"
},
"additional_company_ids": [
0
],
"additional_companies": [
{
"accountable": "string",
"closing_day": 0,
"cnpj": "string",
"cpf": "string",
"celcoin_account": "string",
"is_politically_exposed_person": true,
"accountable_mother_name": "string",
"accountable_birth_date": "2024-11-13T22:10:40.240Z",
"document": "string",
"raw_document": "string",
"account_cpf": "string",
"company_id": 0,
"contact": "string",
"email": "string",
"social_reason": "string",
"social_name": "string",
"fantasy_name": "string",
"month_installment_limit": 0,
"phone": "string",
"webhook_url": "string",
"transfer_fee": 0,
"internal_transfer_fee": 0,
"linked_account_fee": 0,
"accountable_cpf": "string",
"accountable_cnpj": "string",
"accountable_type": 1,
"zipcode": "string",
"street": "string",
"street_number": "string",
"street_complement": "string",
"neighborhood": "string",
"state": "string",
"city": "string",
"financially_blocked": true,
"date_added": "2024-11-13T22:10:40.240Z",
"founding_date": "2024-11-13T22:10:40.240Z",
"settled_pix_invoice_fee": 0,
"cash_in_fixed_fee": 0,
"cash_in_proportional_fee": 0,
"pix_cash_in_key": "string",
"movement_awaiting_balance_enabled": true,
"allowed_order_cron": "string",
"consignation_enabled": true,
"big_data_status": 0,
"consignable_mode": 0,
"max_transfer_cash_out": 0,
"max_payment_cash_out": 0,
"default_pix_key": "string",
"company_type": "string",
"balance": 0,
"swap_account": {
"status": 0,
"individual_id": "string",
"business_id": "string",
"account_holder_id": "string",
"balance_account_group_id": "string",
"balance_account_group_created_at": "2024-11-13T22:10:40.240Z",
"updated_at": "2024-11-13T22:10:40.240Z",
"branch": "string",
"account": 0
},
"actual_closing_date": "2024-11-13T22:10:40.240Z",
"last_closing_date": "2024-11-13T22:10:40.240Z"
}
],
"customer_companies": [
{
"customer_id": 0,
"company_id": 0,
"profile": 1,
"capabilities": "string"
}
],
"addresses": [
{
"street": "string",
"number": "string",
"neighborhood": "string",
"zipcode": "string",
"city": "string",
"state": "string",
"complement": "string"
}
],
"bank_account": {
"document": "string",
"account_number_digit": "string",
"account_number": "string",
"bank_branch": "string",
"account_type_id": 1,
"owner_name": "string",
"document_type_id": 0,
"bank": {
"name": "string",
"code": "string"
}
},
"vehicles": [
{
"license_plate": "string",
"make": "string",
"model": "string",
"year": 0,
"renavam": "string",
"date_added": "2024-11-13T22:10:40.240Z",
"date_deleted": "2024-11-13T22:10:40.240Z"
}
]
},
"company": {
"accountable": "string",
"closing_day": 0,
"cnpj": "string",
"cpf": "string",
"celcoin_account": "string",
"is_politically_exposed_person": true,
"accountable_mother_name": "string",
"accountable_birth_date": "2024-11-13T22:10:40.240Z",
"document": "string",
"raw_document": "string",
"account_cpf": "string",
"company_id": 0,
"contact": "string",
"email": "string",
"social_reason": "string",
"social_name": "string",
"fantasy_name": "string",
"month_installment_limit": 0,
"phone": "string",
"webhook_url": "string",
"transfer_fee": 0,
"internal_transfer_fee": 0,
"linked_account_fee": 0,
"accountable_cpf": "string",
"accountable_cnpj": "string",
"accountable_type": 1,
"zipcode": "string",
"street": "string",
"street_number": "string",
"street_complement": "string",
"neighborhood": "string",
"state": "string",
"city": "string",
"financially_blocked": true,
"date_added": "2024-11-13T22:10:40.240Z",
"founding_date": "2024-11-13T22:10:40.240Z",
"settled_pix_invoice_fee": 0,
"cash_in_fixed_fee": 0,
"cash_in_proportional_fee": 0,
"pix_cash_in_key": "string",
"movement_awaiting_balance_enabled": true,
"allowed_order_cron": "string",
"consignation_enabled": true,
"big_data_status": 0,
"consignable_mode": 0,
"max_transfer_cash_out": 0,
"max_payment_cash_out": 0,
"default_pix_key": "string",
"company_type": "string",
"balance": 0,
"swap_account": {
"status": 0,
"individual_id": "string",
"business_id": "string",
"account_holder_id": "string",
"balance_account_group_id": "string",
"balance_account_group_created_at": "2024-11-13T22:10:40.240Z",
"updated_at": "2024-11-13T22:10:40.240Z",
"branch": "string",
"account": 0
},
"actual_closing_date": "2024-11-13T22:10:40.240Z",
"last_closing_date": "2024-11-13T22:10:40.240Z"
}
}
]