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

Querying Participants by Investor (chat_itau_atendentes)

Scenario

This interface is invoked to query participants by investor.

Method

POST

URI

https://Domain name/apiaccess/rest/ccmessaging/v1/itau/queryAtendentesByInvestidor (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

If a value is transferred, it is passed to the downstream system. If no value is transferred, a UUID is generated and passed to the downstream system.

4

userName

String

Yes

Interface authentication username

5

password

String

Yes

Interface authentication password
Table 2 Request body parameter

No.

Parameter

Type

Mandatory or Not

Description

1.1

investidorId

String

Yes

Investor ID

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1.1

    code

    String

    Yes

    The options are 0 (success) and 1 (failure).

    1.2

    message

    String

    No

    Response message

    1.3

    data

    Object

    No

    Data

    1.3.1

    codigo_tipo_atendente

    String

    No

    Investor level
  • 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

None