Skip to main content

Get Counterparty by ID

GET 
/v1/crossborder/clients/:client_id/counterparties/:id

Retrieve detailed information about a specific crossborder counterparty by providing the counterparty ID.

Request​

Path Parameters

    client_id stringrequired

    Unique identifier (UUID) of the client that owns the counterparty.

    id stringrequired

    Unique identifier (UUID) of the counterparty to retrieve.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

Responses​

Counterparty returned successfully.

Schema
    id stringrequired

    Unique identifier (UUID) of the counterparty.

    name stringrequired

    Full name of the counterparty. For legal entities, the name field corresponds to the legal name.

    nickname string

    Nickname to identify the counterparty.

    type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Type of counterparty entity. NATURAL_PERSON for individuals, LEGAL_PERSON for companies or organizations.

    country string

    Possible values: [AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

    Country code.

    relationship string

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

    Relationship to the beneficiary.

    risk string

    Possible values: [PENDING, LOW, MEDIUM, HIGH]

    Counterparty risk.

    pep booleanrequired

    PEP status of the counterparty.

    status stringrequired

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

    Counterparty lifecycle / verification status (e.g. ACTIVE, INACTIVE, PENDING).

    address object
    id stringrequired

    Address ID.

    street_line_1 stringrequired

    Street line 1.

    street_line_2 string

    Street line 2.

    city stringrequired

    City.

    state stringrequired

    State.

    subdivision string

    Subdivision (optional).

    postal_code stringrequired

    Postal code.

    country stringrequired

    Possible values: [AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

    Country.

    reference_id string

    Reference ID.

    counterparty_verifications object[]

    Counterparty verifications: id, type, provider, status, field_props, created_at, updated_at.

  • Array [
    • id stringrequired

    Counterparty verification ID.

    type stringrequired

    Verification type (e.g. KYC).

    provider stringrequired

    Provider name (e.g. persona).

    status stringrequired

    Status: created, waiting, processed.

    field_props object

    Per-field metadata or validation state for the verification.

    created_at date-timerequired

    Created at.

    updated_at date-timerequired

    Updated at.

  • ]
    • created_at date-timerequired

    Counterparty created date.

    updated_at date-timerequired

    Counterparty updated date.

Loading...