Help Center/ Cognitive Engagement Center/ API Reference/ Web Client Access Interface Reference/ Additional API References/ Querying Customer Information by Account (chat_itau_contas)
Updated on 2025-03-31 GMT+08:00
View PDF
Share

Querying Customer Information by Account (chat_itau_contas)

Scenario

This interface is invoked to query customer information by account.

Method

POST

URI

https://Domain name/apiaccess/rest/ccmessaging/v1/itau/contas (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

x-itau-apikey

String

No

Value of client_id generated during OAuth identity authentication, which is used to authorize the customer to consume the requested application

2

x-itau-correlationID

String

No

Correlation ID, which identifies a group in the audit trail structure and correlates the same calls passed in several different applications/systems

3

x-itau-flowID

String

No

Flow ID

4

userName

String

Yes

API Fabric interface authentication username

5

password

String

Yes

API Fabric interface authentication password
Table 2 Request body parameter

No.

Parameter

Type

Mandatory or Not

Description

1

id_conta

String

Yes

Account

Response Description

  • Status code: 200
    Table 3 itau_response_body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1.1

    data

    Object

    No

    Data

    1.1.1

    id_cliente

    String

    No

    Client ID

    1.1.2

    nome

    String

    No

    Name

    1.1.3

    telefone

    String

    No

    Mobile phone

    1.1.4

    conta_corrente

    String

    No

    Contact

    1.1.5

    agencia

    String

    No

    Communication

    1.1.6

    email_gerente

    String

    No

    Email

    1.1.7

    racf_gerente

    String

    No

    Manager

    1.1.8

    funcional_gerente

    String

    No

    Functional manager

    1.1.9

    segmento

    String

    No

    Segment

    1.1.10

    cod_carteira

    String

    No

    Combination

    1.1.11

    plataforma

    String

    No

    Platform

    1.1.12

    atendimento_plataforma_digital

    String

    No

    Digital platform service

    1.1.13

    codigo_papel

    String

    No

    Paper code

    1.1.14

    tipo_estrutura

    String

    No

    Structure

    1.1.15

    identificado

    String

    No

    Identity certificate
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Error Codes

None

Example

Scenario: Query customer information by account.

URL: https://Domain name/apiaccess/rest/ccmessaging/v1/itau/contas

Request header:

x-app-key :xxxx
x-itau-apikey : xxx
Content-Type :application/json
userName:xxx
password:xxx

Request parameters:

{
    "id_conta": "111"
}

Response parameters:

{
    "data": {
        "id_cliente": "string",
        "nome": "string",
        "telefone": "string",
        "conta_corrente": "string",
        "agencia": "string",
        "email_gerente": "string",
        "racf_gerente": "string",
        "funcional_gerente": "string",
        "segmento": "string",
        "cod_carteira": "string",
        "plataforma": "string",
        "atendimento_plataforma_digital": "string",
        "codigo_papel": "string",
        "tipo_estrutura": "string",
        "identificado": "string"
    }
}