# Get counterparty Retrieves detailed information about a specific counterparty, including complete profile information, customer relationship details, and all associated accounts with comprehensive banking and crypto information. **Endpoint** `GET/v2/counterparty/{counterpartyId}` **Link** {% embed url="" %} ### **Request** #### **Path Parameters** | Parameter | Type | Description | Required | Example | | -------------------- | -------- | -------------------------------------------- | -------- | ------------ | | **`counterpartyId`** | `string` | **Counterparty ID** to retrieve details for. | Yes | `"cp_12345"` | #### **Headers** | Key | Value | Required | | ------------------- | ------------------ | -------- | | **`Authorization`** | `123` | Yes | | **`Accept`** | `application/json` | Yes | *** ### **Response (200 OK)** Returns a complete counterparty object with profile information, customer details, and all associated accounts. #### **Response Fields** **1. Main Counterparty Information** | Field | Type | Description | Example | | -------------------- | -------- | ------------------------------- | -------------------------------- | | **`counterpartyId`** | `string` | Unique counterparty identifier. | `"cp_12345"` | | **`description`** | `string` | Counterparty description. | `"Primary electronics supplier"` | | **`createdAt`** | `string` | Creation timestamp. | `"2024-01-15T10:30:00Z"` | | **`updatedAt`** | `string` | Last update timestamp. | `"2024-05-20T14:45:00Z"` | **2. Profile Object** | Field | Type | Required | Description | Example | | ----------------- | -------- | -------- | ---------------------------- | ---------------------------- | | **`name`** | `string` | **Yes** | Legal name. | `"Tech Supplies Corp"` | | **`email`** | `string` | No | Contact email. | `"contact@techsupplies.com"` | | **`phoneNumber`** | `string` | No | Contact phone. | `"+19876543210"` | | **`taxNumber`** | `string` | No | Tax ID number. | `"TAX-US-12345"` | | **`dateOfBirth`** | `string` | No | Date of birth/incorporation. | `"1985-05-15T00:00:00Z"` | | **`website`** | `string` | No | Company website. | `"https://techsupplies.com"` | | **`lastname`** | `string` | No | Last name (individuals). | `"Smith"` | **3. Address Object** | Field | Type | Required | Description | Example | | ------------------ | -------- | -------- | ---------------- | ------------------- | | **`addressLine1`** | `string` | **Yes** | Primary address. | `"123 Main Street"` | | **`addressLine2`** | `string` | No | Suite/floor. | `"Suite 500"` | | **`addressLine3`** | `string` | No | Additional info. | `"Building B"` | | **`city`** | `string` | No | City. | `"New York"` | | **`stateIso`** | `string` | No | State code. | `"NY"` | | **`countryIso`** | `string` | No | Country code. | `"US"` | | **`postalCode`** | `string` | No | Postal code. | `"10001"` | | **`unitNumber`** | `string` | No | Unit number. | `"5A"` | **4. AdditionalInfo Object** | Field | Type | Description | Allowed Values | Example | | ------------------ | -------- | ---------------------- | ------------------------------------ | ----------------------------------- | | **`type`** | `string` | Legal structure. | `INDIVIDUAL`, `CORPORATION` | `"CORPORATION"` | | **`businessLine`** | `string` | Industry type. | `PLB_AUTOMOTIVE`, `PLB_RETAIL`, etc. | `"PLB_HIGH_TECH_SOFTWARE_TELECOMS"` | | **`relationship`** | `string` | Business relationship. | `PRC_SUPPLIER`, `PRC_CUSTOMER`, etc. | `"PRC_SUPPLIER"` | **5. Customer Object** | Field | Type | Description | Example | | ------------ | -------- | ---------------- | -------------------- | | **`id`** | `string` | Customer ID. | `"cust_12345"` | | **`name`** | `string` | Customer name. | `"John Doe"` | | **`email`** | `string` | Customer email. | `"john@example.com"` | | **`phone`** | `string` | Customer phone. | `"+1234567890"` | | **`status`** | `string` | Customer status. | `"ACCEPT"` | **6. Accounts Array** Array of all accounts associated with this counterparty. | Field | Type | Description | Example | | ------------------ | -------- | ------------------------------ | ----------------------------- | | **`accountId`** | `string` | Unique account identifier. | `"acc_12345"` | | **`currencyCode`** | `string` | Currency code (ISO 4217). | `"USD"` | | **`status`** | `string` | Account status. | `"ACCEPT"` | | **`name`** | `string` | Account name/description. | `"Business Checking Account"` | | **`number`** | `string` | Account number. | `"123456789"` | | **`type`** | `string` | Account type. | `"CHECKING"` | | **`createdAt`** | `string` | Account creation timestamp. | `"2024-01-15T10:30:00Z"` | | **`updatedAt`** | `string` | Account last update timestamp. | `"2024-05-20T14:45:00Z"` | **Bank Account Details** | Field | Type | Description | Example | | ------------------------ | -------- | --------------- | -------------- | | **`bank.name`** | `string` | Bank name. | `"Chase Bank"` | | **`bank.number`** | `string` | Account number. | `"123456789"` | | **`bank.routingNumber`** | `string` | Routing number. | `"021000021"` | **Crypto Account Details** | Field | Type | Description | Example | | ------------------------------------------------- | -------- | -------------------------- | ---------------------------------------------- | | **`crypto.address`** | `string` | Crypto wallet address. | `"0x742d35Cc6634C0532925a3b8D6B3985f8e091be1"` | | **`crypto.additionalInformation.walletType`** | `string` | Wallet type. | `"CPW_INSTITUTION"` | | **`crypto.additionalInformation.type`** | `string` | Account type. | `"TYPE_CRYPTO"` | | **`crypto.additionalInformation.supportedRails`** | `array` | Supported payment methods. | `["CRYPTO"]` | **Fiat Account Details** | Field | Type | Description | Example | | -------------------------------------------- | -------- | --------------- | ------------- | | **`fiat.number`** | `string` | Account number. | `"987654321"` | | **`fiat.swift`** | `string` | SWIFT/BIC code. | `"CHASUS33"` | | **`fiat.routingNumber`** | `string` | Routing number. | `"021000021"` | | **`fiat.additionalInformation.accountType`** | `string` | Account type. | `"CHECKING"` | **Example Response:** json ``` { "item": { "counterpartyId": "cp_12345", "description": "Primary electronics supplier", "profile": { "name": "Tech Supplies Corp", "email": "contact@techsupplies.com", "phoneNumber": "+19876543210", "taxNumber": "TAX-US-12345", "dateOfBirth": "1985-05-15T00:00:00Z", "address": { "addressLine1": "123 Main Street", "addressLine2": "Suite 500", "addressLine3": "Building B", "city": "New York", "stateIso": "NY", "countryIso": "US", "postalCode": "10001", "unitNumber": "5A" }, "website": "https://techsupplies.com", "additionalInfo": { "type": "CORPORATION", "businessLine": "PLB_HIGH_TECH_SOFTWARE_TELECOMS", "relationship": "PRC_SUPPLIER" }, "lastname": "Smith" }, "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-05-20T14:45:00Z", "customer": { "id": "cust_12345", "name": "John Doe", "email": "john@example.com", "phone": "+1234567890", "status": "ACCEPT" } }, "accounts": [ { "accountId": "acc_12345", "currencyCode": "USD", "status": "ACCEPT", "bank": { "name": "Chase Bank", "number": "123456789", "address": { "addressLine1": "456 Bank Street", "city": "New York", "stateIso": "NY", "countryIso": "US", "postalCode": "10002" }, "routingNumber": "021000021" }, "name": "Business Checking Account", "number": "123456789", "type": "CHECKING", "fiat": { "number": "123456789", "routingNumber": "021000021", "additionalInformation": { "type": "TYPE_FIAT_US", "supportedRails": ["ACH", "FEDWIRE"], "accountType": "CHECKING" } }, "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-05-20T14:45:00Z" }, { "accountId": "acc_67890", "currencyCode": "BTC", "status": "ACCEPT", "name": "Bitcoin Wallet", "number": "0x742d35Cc6634C0532925a3b8D6B3985f8e091be1", "type": "CRYPTO_WALLET", "crypto": { "address": "0x742d35Cc6634C0532925a3b8D6B3985f8e091be1", "additionalInformation": { "walletType": "CPW_INSTITUTION", "type": "TYPE_CRYPTO", "supportedRails": ["CRYPTO"] } }, "createdAt": "2024-02-15T14:20:00Z", "updatedAt": "2024-05-18T09:15:00Z" } ] } ``` *** ### **Field Details** #### **Account Status Values** | Status | Description | | ------------------ | --------------------------------------------- | | **`NEW`** | Account newly created, pending verification | | **`AWAIT`** | Awaiting additional information/documentation | | **`MODERATION`** | Under review by compliance team | | **`ACCEPT`** | Approved and active for transactions | | **`REJECT`** | Rejected during verification | | **`BANNED`** | Permanently blocked from transactions | | **`VERIFICATION`** | In verification process | #### **Customer Status Values** | Status | Description | | -------------------------- | --------------------------- | | **`NEW`** | Customer newly created | | **`READY_FOR_MODERATION`** | Ready for compliance review | | **`MODERATED`** | Under moderation | | **`VERIFY`** | In verification process | | **`ACCEPT`** | Approved and active | | **`REJECT`** | Rejected | | **`BANNED`** | Permanently blocked | #### **Business Line Examples** | Business Line | Description | | ------------------------------------------ | --------------------------------- | | **`PLB_HIGH_TECH_SOFTWARE_TELECOMS`** | Technology and telecommunications | | **`PLB_FINANCIAL_AND_CORPORATE_SERVICES`** | Financial services | | **`PLB_MANUFACTURING`** | Manufacturing industry | | **`PLB_RETAIL`** | Retail businesses | | **`PLB_CONSULTING_PROFESSIONAL_SERVICES`** | Professional services | #### **Relationship Types** | Relationship | Description | | -------------------------- | ---------------------------- | | **`PRC_SUPPLIER`** | Vendor/supplier relationship | | **`PRC_CUSTOMER`** | Client/customer relationship | | **`PRC_BUSINESS_PARTNER`** | Strategic business partner | | **`PRC_EMPLOYEE`** | Employee relationship | | **`PRC_NOT_RELATED`** | No specific relationship | *** ### **Examples** #### **Request** bash ``` curl -X GET 'https://stagep.tst-apidmndelss.com/v2/counterparty/cp_12345' \ -H 'Authorization: 123' \ -H 'Accept: application/json' ``` #### **Individual Counterparty Example** **Response:** json ``` { "item": { "counterpartyId": "cp_67890", "description": "Freelance consultant", "profile": { "name": "Jane", "email": "jane@consulting.com", "phoneNumber": "+449876543210", "taxNumber": "UK123456789", "dateOfBirth": "1990-08-20T00:00:00Z", "address": { "addressLine1": "45 Park Lane", "addressLine2": "Flat 3B", "city": "London", "countryIso": "GB", "postalCode": "W1K 7AA" }, "website": "https://janeconsulting.com", "additionalInfo": { "type": "INDIVIDUAL", "businessLine": "PLB_CONSULTING_PROFESSIONAL_SERVICES", "relationship": "PRC_BUSINESS_PARTNER" }, "lastname": "Smith" }, "createdAt": "2024-03-10T14:20:00Z", "updatedAt": "2024-05-15T09:30:00Z", "customer": { "id": "cust_22222", "name": "Sarah Wilson", "email": "sarah@example.com", "phone": "+447123456789", "status": "ACCEPT" } }, "accounts": [ { "accountId": "acc_77777", "currencyCode": "GBP", "status": "ACCEPT", "name": "Personal Current Account", "number": "98765432", "type": "CHECKING", "fiat": { "number": "98765432", "sortCode": "40-30-20", "additionalInformation": { "type": "TYPE_FIAT_GB", "supportedRails": ["FPS", "SWIFT"], "accountType": "CHECKING" } }, "createdAt": "2024-03-10T14:20:00Z", "updatedAt": "2024-04-15T09:30:00Z" } ] } ``` #### **Counterparty with Multiple Accounts Example** **Response:** json ``` { "item": { "counterpartyId": "cp_99999", "description": "International trading partner", "profile": { "name": "Global Imports Ltd", "email": "finance@globalimports.com", "phoneNumber": "+442076543210", "taxNumber": "GB123456789", "address": { "addressLine1": "1 Canada Square", "city": "London", "countryIso": "GB", "postalCode": "E14 5AB" }, "additionalInfo": { "type": "CORPORATION", "businessLine": "PLB_RETAIL", "relationship": "PRC_SUPPLIER" } }, "createdAt": "2024-02-01T09:00:00Z", "updatedAt": "2024-05-10T16:30:00Z", "customer": { "id": "cust_33333", "name": "International Trade Corp", "email": "payments@intltrade.com", "phone": "+13125551212", "status": "ACCEPT" } }, "accounts": [ { "accountId": "acc_88888", "currencyCode": "USD", "status": "ACCEPT", "name": "USD Business Account", "number": "400500600", "type": "CHECKING", "fiat": { "number": "400500600", "swift": "CITIUS33", "additionalInformation": { "type": "TYPE_FIAT_US", "supportedRails": ["ACH", "FEDWIRE", "SWIFT"], "accountType": "CHECKING" } }, "createdAt": "2024-02-01T09:00:00Z", "updatedAt": "2024-03-15T11:20:00Z" }, { "accountId": "acc_99999", "currencyCode": "EUR", "status": "ACCEPT", "name": "Euro Account", "number": "DE89370400440532013000", "type": "CHECKING", "fiat": { "number": "DE89370400440532013000", "swift": "DEUTDEFF", "additionalInformation": { "type": "TYPE_FIAT_EU", "supportedRails": ["SEPA_CT", "SWIFT"], "accountType": "CHECKING" } }, "createdAt": "2024-02-15T14:30:00Z", "updatedAt": "2024-04-20T10:45:00Z" } ] } ``` *** ### **Error Responses** 1. **Counterparty Not Found**: json ``` { "error": "Counterparty not found: cp_99999" } ``` 2. **Unauthorized**: json ``` { "error": "Unauthorized" } ``` *** ### **Notes** * **Complete Profile**: Returns all counterparty details including profile, addresses, and relationships * **Account Relationships**: Includes all accounts associated with the counterparty * **Multi-Currency Support**: Counterparties can have accounts in multiple currencies * **Status Tracking**: Both counterparty and account statuses are included for compliance tracking * **Audit Trail**: Creation and update timestamps provide complete audit history **Common Use Cases**: * Due diligence and KYC verification * Payment processing setup * Relationship management * Compliance reporting * Multi-account management Real reply ```postman_json Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjE2NCwiZXhwIjoxNzYxNzI5MzA3LCJrZXkiOiI1Y2ZiOGZjN2RmYjk4ZjVkYmIyZTgwNTVkZWFhN2U2Zjk4MzEyYmE3Iiwib3RwX3ZlcmlmaWVkIjpmYWxzZX0.ZN7xLzRxRUn-bK67tmoKVcRj-uFwGpYtrQh_LcN0hWE counterpartyId*: DkCSHAN-B9nW-HoakBCwCq36I ``` Real response ```postman_json { "item": { "counterpartyId": "DkCSHAN-B9nW-HoakBCwCq36I", "description": "", "profile": { "name": "Test Eugen USD", "email": "Test Eugen USD", "phoneNumber": "111", "taxNumber": "Test Eugen USD", "dateOfBirth": "1970-01-01T00:00:00Z", "address": { "addressLine1": "Test Eugen USD", "addressLine2": "Test Eugen USD", "addressLine3": "Test Eugen USD", "city": "Test Eugen USD", "stateIso": "Test Eugen USD", "countryIso": "Test Eugen USD", "postalCode": "Test Eugen USD", "unitNumber": "Test Eugen USD" }, "website": "Test Eugen USD", "additionalInfo": { "type": "INDIVIDUAL", "businessLine": "PLB_TECHNICAL_SUPPORT", "relationship": "PRC_SPOUSE" }, "lastname": "" }, "createdAt": "2025-01-28T09:03:54Z", "updatedAt": "2025-01-28T12:19:35Z", "customer": { "id": "Dnewcvn-euuI-vG0FZCRDjLXS", "name": "Test Eugen Test Eugen", "email": "", "phone": "", "status": "ACCEPT" } }, "accounts": [ { "accountId": "UDHW6vxOePli", "currencyCode": "USD", "status": "ACCEPT", "bank": { "name": "Test Eugen USD", "number": "Test Eugen USD", "address": { "addressLine1": "Test Eugen USD", "addressLine2": "", "addressLine3": "", "city": "Test Eugen USD", "stateIso": "Test Eugen USD", "countryIso": "Test Eugen USD", "postalCode": "Test Eugen USD", "unitNumber": "Test Eugen USD" } }, "name": "Test Eugen USD", "number": "Test Eugen USD", "type": "Fiat", "fiat": { "number": "Test Eugen USD", "ifsc": "1234", "swift": "Test Eugen USD", "sortCode": "", "name": "Test Eugen USD", "transitNumber": "Test Eugen USD", "routingNumber": "Test Eugen USD", "additionalInformation": { "type": "TYPE_FIAT", "supportedRails": [ "SWIFT" ], "accountType": "CHECKING" }, "accountNumberType": "ANT_NOTSET", "transitNumberCode": "TNC_NOTSET" }, "createdAt": null, "updatedAt": null } ] } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.delos.financial/counterparties/get-counterparty.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.