获取所有 Counterparties

GET

https://api.cobre.co/v1/counterparties

该接口端点用于检索所有 Counterparties。

隐私保护功能

为确保对机密数据的最高级别保护，该 API 配备了对交易对手方详细信息中敏感内容进行脱敏的功能。通过使用 sensitive_data 参数，您可以灵活自定义 API 的响应格式以满足特定需求，确保敏感信息以安全的方式呈现。

该功能不仅能让您对数据安全保持信心，还支持定制化的信息检索，使安全、高效地管理交易对手方信息变得更加便捷。

请参阅 Managing Counterparties guide

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200Correcto

application/json

示例响应

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.cobre.co/v1/counterparties?page_number=undefined&sensitive_data=undefined&alias=undefined&counterparty_full_name=undefined&type=undefined&counterparty_id_number=undefined&account_number=undefined&counterparty_email=undefined&registered_account=undefined&beneficiary_institution=undefined&created_at=undefined&created_gte=undefined&created_lte=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "total_items": 1,
    "total_pages": 1,
    "is_last_page": false,
    "page_items": 50,
    "contents": [
        {
            "id": "cp_NBJCEY7UXn",
            "geo": "col",
            "type": "cc",
            "alias": "Cobre's main account",
            "metadata": {
                "account_number": "023550031",
                "beneficiary_institution": "1023",
                "counterparty_email": "fernando.alonso@cobre.co",
                "counterparty_fullname": "Fernando Alonso Díaz",
                "counterparty_id_number": "5334623427",
                "counterparty_id_type": "cc",
                "counterparty_phone": "+18800347411",
                "registered_account": "false"
            },
            "created_at": "2025-12-01T05:38:54Z",
            "updated_at": "2025-12-01T05:38:54Z"
        }
    ]
}

Modified at 2026-05-20 21:31:19

获取单个 Counterparty

删除 Counterparty

获取所有 Counterparties

隐私保护功能#

Request

Responses

隐私保护功能