Querying Customer Information by Account (chat_itau_codigo)
Scenario
This interface is invoked to query customer information by account.
Method
POST
URI
https://Domain name/apiaccess/rest/ccmessaging/v1/itau/codigo (For example, the domain name is service.besclouds.com.)
Request Description
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 |
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1.1 |
codigo_conta |
String |
Yes |
Account ID. Format: Company (3 digits) + Bank (3 digits) + Account (4 proxy digits) + (7 c / c) + (1 DAC digit) |
1.2 |
tipo_estrutura |
String |
No |
Structure type, for example, AP, OP, SD, or CO |
1.3 |
segmento |
String |
No |
Customer segment |
1.4 |
servico_digital |
String |
No |
Digital service |
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
emails
Array [Object]
No
Email information
1.1.2.1
principal
String
No
Whether an email is a main email
1.1.2.2
email
String
No
Email address
1.1.2.3
data_atualizacao
String
No
Update time
1.1.3
data_abertura_conta
String
No
Account creation date
1.1.4
nome_completo
String
No
Complete name
1.1.5
nome_fantasia_apelido
String
No
Surname
1.1.6
tipo_pessoa
String
No
Gender
1.1.7
data_nascimento_fundacao
String
No
Birthday
1.1.8
gerentes
No
Management information
1.1.9
telefones
Array [telefones]
No
Mobile phone information
1.1.10
identificado
String
No
Identification information
1.1.11
cpf_cnpj
String
No
Common No.
1.1.12
nome_social
String
No
Valid name
1.1.13
agencia
String
No
Agency
1.1.14
conta_corrente
String
No
Common account
Table 4 gerentes parameters No.
Parameter
Type
Mandatory or Not
Description
1.1
email_gerente
String
No
Email address
1.2
racf_gerente
String
No
Manager
1.3
funcional_gerente
String
No
Functional manager
1.4
segmento
String
No
Segment
1.5
cod_carteira
String
No
Combination
1.6
plataforma
String
No
Platform
1.7
atendimento_plataforma_digital
String
No
Digital platform service
1.8
codigo_papel
String
No
Paper code
1.9
descricao_categoria
String
No
Category
1.10
tipo_estrutura
String
No
Structure
1.11
telefones
No
Mobile phone information
1.12
codigo_cargo
String
No
Skill queue to be allocated to the AGD/AGF media
Table 5 telefones parameters No.
Parameter
Type
Mandatory or Not
Description
1.1
principal
String
No
Whether a mobile phone is a main phone
1.2
celular
String
No
Mobile phone
1.3
ddi
String
No
ddi
1.4
ddd
String
No
First two digits of the calling number
1.5
numero
String
No
Number
1.6
ramal
String
No
Extension
- 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/codigo
Request header:
x-app-key :xxxxxx x-itau-apikey : 12323213 Content-Type :application/json userName:chat_itau_oiap password:****************
Request parameters:
{ "codigo_conta":"94****96@qq.com", "tipo_estrutura": "string" }
Response parameters:
{ "data": { "id_cliente": "b26e641a-71f5-4117-ad0d-4d753faebb16", "data_abertura_conta": "", "nome_completo": "", "nome_fantasia_apelido": "", "tipo_pessoa": "", "data_nascimento_fundacao": "", "gerentes": { "email_gerente": "gerente@itau-unibanco.com.br", "racf_gerente": "", "funcional_gerente": "", "segmento": "", "cod_carteira": "", "plataforma": "", "atendimento_plataforma_digital": "", "codigo_papel": "", "descricao_categoria": "", "tipo_estrutura": "", "telefones": { "principal": "", "celular": "", "ddi": "", "ddd": "", "numero": "", "ramal": "" } }, "identificado": "Identificado", "cpf_cnpj": "", "nome_social": "", "agencia": "1501", "conta_corrente": "098797" } }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot