HomeGuidesREST APISOAP APIChangelogAEB Trade Compliance WebsiteLegal Notice
REST API

A Good Guy

post
https://rz3.aeb.de/test4ce/rest/ComplianceScreening/goodGuy

Create a Good Guy if it does not already exist. A Good Guy with exactly the same address fields will not be created twice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Data transfer object for a Good Guy address.

string
enum

The addressTypeVersion of MatchParametersDTO defines the result behavior of this field when calling /ComplianceScreening/findMatchingAddresses.
If addressTypeVersion 0 is used, the possible return values are:

  • company
  • individual
  • bank
  • vessel
If addressTypeVersion 1 is used, the possible return values are:
  • entity
  • individual
  • meansOfTransport
  • unknown

Depending on the profile settings, this field might be relevant for the address check.

Allowed:
string
length ≤ 200

Full name of the address, e.g. name of the company (address line 1 - 4) or prename and surname of an individual.
Depending on the profile settings, this field might be relevant for the address check.

string
length ≤ 100

Street of the address, including house number.
This field is relevant for the address check.

string
length ≤ 40

Postal code of the city.
This field is relevant for the address check.

string
length ≤ 100

City of the address.
This field is relevant for the address check.

string
length ≤ 50

District of the address, resp. line 2 of the city (in German: Ortsteil).

string
length ≤ 2

Two character ISO code of the country.
This field is relevant for the address check.

string
length ≤ 40

Telephone number.

string
length ≤ 20

The P.O. box of the address.
Depending on the profile settings, this field might be relevant for the address check.

string
length ≤ 40

The postal code of the P.O. box, if the postal code of the P.O. box differs from the postal code of the street address.

string
length ≤ 100

The city of the P.O. box, if the city of the P.O. box differs from the city of the street address.

string
length ≤ 256

Email address.

string
length ≤ 40

Fax number.

string
length ≤ 50

Additional information only for companies: The first line of the addresses name.
Depending on the profile settings, this field might be relevant for the address check.

string
length ≤ 50

Additional information only for companies: The second line of the addresses name.
Depending on the profile settings, this field might be relevant for the address check.

string
length ≤ 50

Additional information only for companies: The third line of the addresses name.
Depending on the profile settings, this field might be relevant for the address check.

string
length ≤ 50

Additional information only for companies: The fourth line of the addresses name.
Depending on the profile settings, this field might be relevant for the address check.

string
length ≤ 20

Additional information only for individuals: The title of a person.

string
length ≤ 50

Additional information only for individuals: The surname of a person.

string
length ≤ 50

Additional information only for individuals: The prenames of a person.

string
length ≤ 20

The date of birth in textual representation, e.g. 1962-08-20 or just 1962 or other date formats. (Only human-readable.)

string
length ≤ 200

Additional information only for individuals: Textual information about the passport, e.g. passport no. and date of issue.

string
length ≤ 50

Additional information only for individuals: City of birth.

string
length ≤ 2

Additional information only for individuals: Two-letter ISO code for the country of birth.

string

Additional information only for individuals: Two-letter ISO code for the nationality.
(max. length: 2)

string
length ≤ 200

Additional information only for individuals: Textual information about the position of the individual.

string
length ≤ 50

Additional identification tokens or numbers of individuals.

string
length ≤ 1000

Summary additional information, e.g. alias names or information composed of other field like position, passportData, dateOfBirth.

string
length ≤ 20

Number or name of the group under which all addresses are summarized describing the same person or organization.

string
length ≤ 50

Additional field for future use.

string
length ≤ 50

Additional field for future use.

string
length ≤ 50

Additional field for future use.

string
length ≤ 50

Additional field for future use.

string
length ≤ 50

Additional field for future use.

string
length ≤ 50

Additional field for future use.

string
length ≤ 50

Additional field for future use.

ids
array of objects

Optional IDs of the address, e.g. like DUNS number or passport number.

ids
string
required
length ≤ 10

Ident code of the client the Good Guy belongs to. The value must be a valid ident code of an existing client.

string
required
length ≤ 20

Ident code of a Compliance profile. The value must be a valid ident code of a profile valid for the specified client.

string
length ≤ 20

The unique ID of the host system calling this API. Used in log entries on any actions performed on the Good Guy.

string
length ≤ 255

Ident code of the organizational unit. Currently not used. Functionality will be added at a later date.

string
length ≤ 255

Reference ID for logging.

string
length ≤ 3000

Reference comment for logging.

boolean
Defaults to true

Defines whether the Good Guy is active or not. Inactive Good Guys are not considered during address screening. If omitted, the Good Guy is active by default.
Only used when a new Good Guy is created.

string
length ≤ 100

The users name to be used for logging.

condition
object

Optional condition for the Good Guy. If omitted, the Good Guy is unconditional. If given, the Good Guy is only used in address checks that meet the condition.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 28 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 28 days ago