# Counterparties

A request to retrieve a list of accounts in the registry that are valid for certificate transfers. This should be all NAR accounts that can buy or sell certificates (this will not include MA Biomass accounts).

Endpoint: GET /api/account/counterparty
Version: 1.0.0
Security: JWT

## Query parameters:

  - `counterpartyAccountIds` (array)
    Counterparty account ids: if specified, limits the results to the counterparty accounts whose ids match the provided set

  - `$filter` (string)
    OData-like filter expression

  - `$orderby` (string)
    Comma-separated list of columns for sorting

  - `$skip` (integer)
    Number of records to skip

  - `$top` (integer)
    Maximum number of records to return

  - `$apply` (string)
    OData-like apply expression with groupby and aggregate only

## Response 200 fields (application/json):

  - `@count` (integer)

  - `value` (array, required)

  - `value.accountId` (integer, required)
    The account identifier
    Example: "55"

  - `value.name` (string, required)
    The account name
    Example: "Acme Corp."

  - `value.accountType` (string, required)
    The account type
    Example: "General Account"

  - `value.website` (string)
    The account website
    Example: "acmecorp.com"

  - `value.isTransferor` (boolean)
    Indicates whether the account is eligible to sell certificates.

  - `value.isTransferee` (boolean)
    Indicates whether the account is eligible to buy certificates.

  - `totalCount` (integer)

  - `countExceeded` (boolean, required)

## Response 400 fields (application/json):

  - `submissionId` (string)
    Submission identifier for issue investigation

  - `errors` (array)
    List of errors

  - `errors.parameter` (string)
    The parameter in error, if applicable

  - `errors.correlationId` (string)
    The correlation identifier from the input

  - `errors.path` (string)
    The path to the field specifically in error, if applicable

  - `errors.field` (string)

  - `errors.code` (string)
    The field in error, if applicable

  - `errors.message` (string, required)
    The error code

## Response 401 fields (application/json):

  - `submissionId` (string)
    Submission identifier for issue investigation

  - `errors` (array)
    List of errors

  - `errors.parameter` (string)
    The parameter in error, if applicable

  - `errors.correlationId` (string)
    The correlation identifier from the input

  - `errors.path` (string)
    The path to the field specifically in error, if applicable

  - `errors.field` (string)

  - `errors.code` (string)
    The field in error, if applicable

  - `errors.message` (string, required)
    The error code

## Response 403 fields (application/json):

  - `submissionId` (string)
    Submission identifier for issue investigation

  - `errors` (array)
    List of errors

  - `errors.parameter` (string)
    The parameter in error, if applicable

  - `errors.correlationId` (string)
    The correlation identifier from the input

  - `errors.path` (string)
    The path to the field specifically in error, if applicable

  - `errors.field` (string)

  - `errors.code` (string)
    The field in error, if applicable

  - `errors.message` (string, required)
    The error code

## Response 429 fields (application/json):

  - `submissionId` (string)
    Submission identifier for issue investigation

  - `errors` (array)
    List of errors

  - `errors.parameter` (string)
    The parameter in error, if applicable

  - `errors.correlationId` (string)
    The correlation identifier from the input

  - `errors.path` (string)
    The path to the field specifically in error, if applicable

  - `errors.field` (string)

  - `errors.code` (string)
    The field in error, if applicable

  - `errors.message` (string, required)
    The error code

## Response 500 fields (application/json):

  - `submissionId` (string)
    Submission identifier for issue investigation

  - `errors` (array)
    List of errors

  - `errors.parameter` (string)
    The parameter in error, if applicable

  - `errors.correlationId` (string)
    The correlation identifier from the input

  - `errors.path` (string)
    The path to the field specifically in error, if applicable

  - `errors.field` (string)

  - `errors.code` (string)
    The field in error, if applicable

  - `errors.message` (string, required)
    The error code