GET/counterparty/{userId}/counterparties/{counterpartyId}

Get Counterparty By ID

Returns full details of a specific counterparty.

Path variables

Field	Type	Required	Possible values	Description
`userId`	string	Required	—	Unique user ID.
`counterpartyId`	string	Required	—	Unique counterparty ID.

Headers

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	Full details of the counterparty.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "CpUserId": "4088034044546559830",
    "Status": "Active",
    "DepositInformation": "",
    "PersonalDetail": [
      {
        "DetailsType": "Basic Information",
        "Fields": [
          {
            "Label": "First Name",
            "Value": "jane.smith"
          },
          {
            "Label": "Middle Name",
            "Value": null
          },
          {
            "Label": "Last Name",
            "Value": "Tiwari"
          },
          {
            "Label": "Date of Birth",
            "Value": "1990-05-15"
          },
          {
            "Label": "Email",
            "Value": "test.user@example.com"
          },
          {
            "Label": "Phone",
            "Value": null
          }
        ]
      },
      {
        "DetailsType": "Address Information",
        "Fields": [
          {
            "Label": "Address",
            "Value": "Apt 4B 123 Main Street"
          },
          {
            "Label": "City",
            "Value": "New York"
          },
          {
            "Label": "State",
            "Value": "NY"
          },
          {
            "Label": "Country",
            "Value": "United States of America"
          },
          {
            "Label": "Postal Code",
            "Value": "10001"
          }
        ]
      }
    ]
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "CpUserId": "4088034044546559830",
    "Status": "Active",
    "DepositInformation": "",
    "PersonalDetail": [
      {
        "DetailsType": "Basic Information",
        "Fields": [
          {
            "Label": "First Name",
            "Value": "jane.smith"
          },
          {
            "Label": "Middle Name",
            "Value": null
          },
          {
            "Label": "Last Name",
            "Value": "Tiwari"
          },
          {
            "Label": "Date of Birth",
            "Value": "1990-05-15"
          },
          {
            "Label": "Email",
            "Value": "test.user@example.com"
          },
          {
            "Label": "Phone",
            "Value": null
          }
        ]
      },
      {
        "DetailsType": "Address Information",
        "Fields": [
          {
            "Label": "Address",
            "Value": "Apt 4B 123 Main Street"
          },
          {
            "Label": "City",
            "Value": "New York"
          },
          {
            "Label": "State",
            "Value": "NY"
          },
          {
            "Label": "Country",
            "Value": "United States of America"
          },
          {
            "Label": "Postal Code",
            "Value": "10001"
          }
        ]
      }
    ]
  }
}

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.