Skip to main content

CounterpartyRestResponse

    id stringrequired

    Counterparty ID.

    name stringrequired

    Counterparty name. For legal entities, the name field corresponds to the legal name.

    nickname string

    Nickname to identify the counterparty.

    type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Counterparty type.

    country object

    Counterparty country.

    relationship string

    Possible values: [EMPLOYEE, CONTRACTOR, VENDOR, SUBSIDIARY, MERCHANT, CUSTOMER, LANDLORD, FAMILY, OTHER]

    Relationship to the beneficiary.

    status string

    Possible values: [ACTIVE, INACTIVE, PENDING, REJECTED, EXPIRED]

    Counterparty lifecycle / verification status.

    created_at date-time

    Counterparty created date.

    updated_at date-time

    Counterparty updated date.