GetCounteragentCertificates (V2)

Возвращает список сертификатов контрагента.

GET /V2/GetCounteragentCertificates
Query Parameters:
  • myBoxId – идентификатор ящика организации, от лица которой будет произведен поиск сертификатов контрагента.

  • counteragentBoxId – идентификатор ящика ящика контрагента, для которого будет выполнен поиск сертификатов.

Request Headers:
Status Codes:
  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у указанного ящика закончилась подписка на API.

  • 403 Forbidden – доступ к списку сертификатов организации counteragentBoxId от организации myBoxId с предоставленным авторизационным токеном запрещен.

  • 404 Not Found – партнерские отношения между указанными организациями не установлены.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит структуру CounteragentCertificateList:

message CounteragentCertificateList {
    repeated Certificate Certificates = 1;
}

message Certificate {
    required bytes RawCertificateData = 1;
}
  • Certificates — список сертификатов контрагента, представленных структурой Certificate с полями:

    • RawCertificateData — сертификат, сериализованный в массив байтов в DER-кодировке.

Метод доступен только сотрудникам с доступом к ящику.

Организация может запросить список сертификатов контрагента только если у нее включена возможность отправки зашифрованных документов. Эта возможность указана в поле EncryptedDocumentsAllowed структуры Organization.Box.

Примеры использования

Пример HTTP-запроса:

GET /V2/GetCounteragentCertificates?myBoxId={{myBoxId}}&counteragentBoxId={{counteragentBoxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

Пример тела ответа:

{
    "Certificates": [
        {
            "RawCertificateData": "MIIIyjCCCHegAwIBAgIRAdD...Brfw=="
        }
    ]
}

См. также

Инструкции:
Методы для работы с контрагентами:
  • AcquireCounteragent (V3) — отправляет контрагенту приглашение к партнерским отношениям

  • AcquireCounteragentResult (V2) — возвращает результат приглашения контрагента к партнерским отношениям

  • BreakWithCounteragent (V2) — разрывает партнерские отношения с контрагентом

  • GetCounteragent (V3) — возвращает данные контрагента по указанному идентификатору

  • GetCounteragentCertificates (V2) — возвращает список сертификатов контрагента

  • GetCounteragents (V3) — выполняет поиск контрагентов по указанным параметрам

Методы для работы с сертификатами:
  • CanSendInvoice — позволяет узнать, может ли указанный сертификат использоваться для подписания электронных счетов-фактур

  • GetCounteragentCertificates (V2) — возвращает список сертификатов контрагента

  • GetMyCertificates — возвращает список сертификатов, привязанных к текущему авторизованному пользователю

Устаревшие версии метода: