Party

This API endpoint allows you to fetch detailed information about a specific party. By providing the party’s email, you can access party attributes, contact details, and other relevant data.

GET /omni-omni/v1/parties/{email}

🌱 Retrieve party information

cURL

curl --request GET \
  --url https://backend.sandbox.ecrop.de/ecrop-command/omni-omni/v1/parties/{email} \
  --header 'Authorization: Bearer <token>'

200

{
  "email": "<string>",
  "legalParty": {
    "businessSectors": [],
    "companyName": "<string>",
    "customersLocations": [
      "<string>"
    ],
    "customersPaymentTypes": [],
    "description": "<string>",
    "registeredAddress": {
      "city": "<string>",
      "countryIso2": "<string>",
      "houseNo": "<string>",
      "street": "<string>",
      "zip": "<string>"
    },
    "registrationNumber": "<string>",
    "statute": {
      "description": "<string>",
      "title": "<string>",
      "id": 123,
      "url": "<string>"
    },
    "symbol": "<string>"
  },
  "naturalParty": {
    "firstName": "<string>",
    "lastName": "<string>",
    "nationality": "<string>",
    "residentialAddress": {
      "city": "<string>",
      "countryIso2": "<string>",
      "houseNo": "<string>",
      "street": "<string>",
      "zip": "<string>"
    },
    "birthDate": "2023-12-25",
    "image": {
      "description": "<string>",
      "title": "<string>",
      "id": 123,
      "url": "<string>"
    },
    "kyc": {
      "caseId": "<string>",
      "caseResult": [
        {
          "description": "<string>",
          "title": "<string>",
          "id": 123,
          "url": "<string>"
        }
      ]
    },
    "links": [
      {
        "title": "<string>",
        "url": "<string>",
        "id": 123,
        "insertDate": "2023-11-07T05:31:56Z",
        "modifyDate": "2023-11-07T05:31:56Z"
      }
    ],
    "mobile": "<string>",
    "pepFlag": true,
    "phoneNumber": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

email · string · required

Response

200 - application/json

Party information retrieved

email · string · required

legalParty · object

Show child attributes

naturalParty · object

Show child attributes