Profile Details

Compatible Cases

Icon 1

About the service

ProfileDetails is a profile retrieval service. For any check that returns a profile ID this service will retrieve the full report on that ID.

Product Code: W2-DATA-PROFILE_DETAILS-024

Does this service leave a credit search Footprint? No


Request

The following properties pertain to this service.

Property NameTypeMandatoryNotes
ProfileIDString🔒A unique profile reference, as returned by one of the 'Check' services.
NB: For UK Directors the ID returned by DirectorUKCheck the Companies House number must be prefixed with 'DIR-', e.g. 'DIR-99999999'.

Responses

Director UK Response

Example Response for Director UK Details:

{
  "ProfileDetailsResult": {
    "DirectorUKDetailsResult": {
      "DirectorUKDetailsDirector": {
        "Address1": "221B Baker Street",
        "Address4": "London",
        "BirthDate": "01/01/1970",
        "DirectorNumber": "123456789",
        "Directorships": {
          "Directorship": {
            "AppointDate": "01/01/1980",
            "CompanyName": "DIRSE LLP",
            "CompanyNumber": "AB123456",
            "CompanyStatus": "Active - Accounts Filed",
            "CreditLimit": "10000",
            "CreditRating": "79",
            "Function": "LLP Member"
          }
        },
        "Name": "Jessica Black",
        "Nationality": "U.KINGDOM",
        "Postcode": "W1S 1AA",
        "Title": "Mrs"
      }
    }
  }
}

Director UK Response breakdown

Property NameTypeDescription
Address1StringFirst line of address.
Address2StringSecond line of address.
Address3StringThird line of address.
Address4StringFourth line of address.
Address5StringFifth line of address.
BirthDateStringDate of birth in a 'dd/MM/yyyy' format.
DirectorNumberStringNumber of director.
DirectorshipsDirectorshipsList of directorships held by director. See below.
HonoursStringHonours held by director.
NameStringName of director.
NationalityStringNationality of director.
PostcodeStringPostcode of director.
TitleStringTitle of director.

Directorships

Directorships are a collection of one or more Directorship items, which are defined below.


PEP Details Response

Example Response for PEP Details:

"profileDetailsResult": {
	"pepDeskDetailsResult": {
		"additionalInformation": [],
		"country": [
			"European Union",
			"United Kingdrom"
		],
		"dateOfBirth": [
			"09.10.1966"
		],
		"functionDetails": [{
				"category": "State Executive Function, Government, Ministries",
				"dateNotInchargeSince": "",
				"exPEP": false,
				"function": "European Council",
				"specificFunction": "Member"
			}, {
				"category": "Heads of State, Major Government Offices and Support",
				"dateNotInchargeSince": "",
				"exPEP": false,
				"function": "Office of the Prime Minister, Cabinet Office",
				"specificFunction": "Minister for the Civil Service"
			}, {
				"category": "Political Leaders",
				"dateNotInchargeSince": "",
				"exPEP": false,
				"function": "Conservative Party",
				"specificFunction": "Leader"
			}
		],
		"gender": "Male",
		"nameDetails": [{
				"alternativeScript": "",
				"firstName": "David William Donald",
				"fullName": "",
				"lastName": "Cameron",
				"otherName": "Cameron, David",
				"title": "Mr."
			}, {
				"alternativeScript": "",
				"firstName": "David William Donald",
				"fullName": "",
				"lastName": "Cameron",
				"otherName": "Cameron, David",
				"title": "The Rt Hon Mr."
			}
		],
		"placeOfBirth": [
			"London, United Kingdom"
		]
	}
}

PEP Details Response breakdown

Property NameTypeDescription
AdditionalInformationString
CountryString
DateOfBirthString
FunctionDetailsPEPDeskFunctionDetailsSee below
GenderString
NameDetailsPEPDeskNameDetailsSee below
PlaceOfBirthString

PEPDeskFunctionDetails

Property NameTypeDescription
FunctionString
SpecificFunctionString
CategoryString
DateNotInchargeSinceString
ExPEPBoolean

PEPDeskNameDetails

Property NameTypeDescription
TitleString
FirstNameString
LastNameString
FullNameString
OtherNameString
AlternativeScriptString

SIS Plus / SPF Plus Details Response

Example Response for SIS Plus / SPF Plus Details:

{
    "sisPlusDetailsResult": {
        "active": true,
        "addressDetails": [
            {
                "address": "",
                "addressRemarks": "",
                "city": "",
                "country": "Korea, North",
                "postcode": "",
                "province": ""
            }
        ],
        "aliasDetails": [],
        "callsign": [""],
        "citizenShip": [],
        "constituancy": [],
        "dateOfBirth": [],
        "documents": [],
        "email": [],
        "eyes": [],
        "fax": [],
        "grt": [],
        "hair": [],
        "height": [],
        "imageUrl": [],
        "languages": [],
        "legalBasis": [],
        "listingDate": [],
        "marks": [],
        "nameDetails": [
            {
                "courtesyTitle": "",
                "firstName": "",
                "fullName": "KIM, Jong Un",
                "lastName": "",
                "middleName": "",
                "suffix": "",
                "title": "Chairman of the Workers' Party of Korea"
            }
        ],
        "offense": [],
        "pageUrl": [
            "http://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx"
        ],
        "phone": [],
        "placeOfBirth": [],
        "politicalParty": [],
        "program": ["DPRK3"],
        "remarks": [
            "DOB 08 Jan 1984; Secondary sanctions risk: North Korea Sanctions Regulations, sections 510.201 and 510.210; Transactions Prohibited For Persons Owned or Controlled By U.S. Financial Institutions: Nor


SIS Plus / SPF Plus Details Response breakdown

Property NameTypeDescription
NameDetailsSanctionsPlusNameDetailsSee below.
EyesString
HairString
WeightString
HeightString
MarksString
SexString
LanguagesString
TINString
DocumentsString
PlaceOfBirthString
DateOfBirthString
CitizenshipString
PhoneString
FaxString
EmailString
WebsiteString
ConstituancyString
PoliticalPartyString
ImageURLString
PageURLString
SourceString
TypeString
OffenseString
WantedByString
ProgramString
LegalBasisString
ListingDateString
CallsignString
VesselTypeString
TonnageString
GRTString
VesselFlagString
VesselOwnerString
RemarksString
AddressDetailsSanctionsPlusAddressDetailsSee below.
AliasDetailsSanctionsPlusAliasDetailsSee below.
RiskCodeString
ActiveBoolean
TimestampDateTime

Sanctions Plus Name Details

Property NameTypeDescription
FullNameString
CourtesyTitleString
FirstNameString
MiddleNameString
LastNameString
SuffixString
TitleString

Sanctions Plus Address Details

Property NameTypeDescription
AddressString
CityString
ProvinceString
PostcodeString
CountryString
AddressRemarksString

Sanctions Plus Alias Details

Property NameTypeDescription
AliasTypeString
AliasNameString

Watchlist Details Response

Example Response for Watchlist Details:

"watchlistDetailsResult": {
                "personProfileMatchDetails": {
                    "action": "Add",
                    "actionDate": "11-Jun-2014",
                    "activeStatus": "Inactive",
                    "addresses": [],
                    "aliases": [
                        {
                            "aliasType": "PrimaryAlias",
                            "combinedName": "Yong Un Kim",
                            "firstName": "Yong Un",
                            "maidenName": "",
                            "middleName": "",
                            "originalScriptName": "김용운",
                            "singleStringName": "",
                            "suffix": "",
                            "surname": "Kim",
                            "titleHonorific": ""
                        },
                        {
                            "aliasType": "SpellingVariation",
                            "combinedName": "Yong-Un Kim",
                            "firstName": "Yong-Un",
                            "maidenName": "",
                            "middleName": "",
                            "originalScriptName": "",
                            "singleStringName": "",
                            "suffix": "",
                            "surname": "Kim",
                            "titleHonorific": ""
                        }
                    ],
                    "associations": [],
                    "birthPlaces": [],
                    "classifications": [
                        {
                            "watchlistClassification": "Politically Exposed Person (PEP)"
                        }
                    ],
                    "countries": [
                        {
                            "countryCode": "NKOREA",
                            "countryName": "North Korea",
                            "countryType": "Citizenship"
                        },
                        {
                            "countryCode": "NKOREA",
                            "countryName": "North Korea",
                            "countryType": "Resident of"
                        },
                        {
                            "countryCode": "NKOREA",
                            "countryName": "North Korea",
                            "countryType": "Jurisdiction"
                        }
                    ],
                    "dateEvents": [
                        {
                            "dateType": "Inactive as of (PEP)",
                            "month": 3,
                            "year": 2009
                        }
                    ],
                    "deceased": false,
                    "gender": "Male",
                    "identifiers": [],
                    "images": [],
                    "matchType": "Person",
                    "occupations": [
                        {
                            "occupationName": "Members of the National Legislature",
                            "roleTypeName": "Primary Occupation",
                            "title": "See Previous Roles"
                        },
                        {
                            "occupationName": "Members of the National Legislature",
                            "roleTypeName": "Previous Roles",
                            "sinceMonth": 8,
                            "sinceYear": 2003,
                            "title": "Delegate, Supreme People's Assembly, Constituency 657",
                            "toMonth": 3,
                            "toYear": 2009
                        }
                    ],
                    "primaryAlias": "Yong Un Kim",
                    "profileId": "4b56c673-b6fb-b269-0ca4-18a2c53d7586",
                    "sanctions": [],
                    "sources": []
                }

Watchlist details response breakdown

Property NameTypeDescription
ActionWatchlistActionStatusEnumThe last action that was performed on the record. See below for more information.
ActionDateStringThe date the last action was performed on the record.
ActiveStatusWatchlistActiveStatusEnumWhether or not the record is marked as active. See below for more information.
AddressesWatchlistAddressDataThe addresses of the record. See below for details.
AliasesWatchlistEntityAliasDataThe aliases of the record. See below for details.
AssociationsWatchlistAssociateDataThe known associates of the record. See below for details.
BirthPlacesWatchlistBirthPlaceDataInformation about the birth places of the record. See below for details.
ClassificationsWatchlistClassificationDataThe classifications of the record. See below for details.
CountriesWatchlistCountryDataThe countries associated with the record. See below for details.
DateEventsWatchlistDateEventDataThe dates of key events related to the record. See below for details.
DeceasedBooleanWhether or not the record is deceased.
GenderWatchlistGenderEnumThe gender of the record. See below for details.
IdentifiersWatchlistIdentifierDataAny identifiers associated with the record. See below for details.
ImagesWatchlistImageDataAny images associated with the record. See below for details.
MatchTypeMatchTypeEnumThe type of record. See below for details.
OccupationsWatchlistOccupationDataThe occupations associated with the record. See below for details.
PrimaryAliasStringThe primary alias of the record.
ProfileIdStringThe unique Profile Id for this record.
ProfileNotesStringAdditional notes associated with the record.
SanctionsWatchlistSanctionDataThe sanctions that apply to this record. See below for details.
SourcesWatchlistSourceDataThe sources the information about this record is derived from.
VesselsWatchlistVesselDataAny vessels (usually maritime) associated with the record. See below for details.

WatchlistActionStatusEnum

Enumeration NameValueDescription
Delete1Represents a delete action.
Change2Represents a change action.
Add3Represents an add action.

WatchlistActiveStatusEnum

Enumeration NameValueDescription
Active1The record is active.
Inactive2The record is inactive.

WatchlistAddressData

Property NameTypeDescription
AddressLineStringThe first line of the address, usually house number, street name, PO Box, etc.
CountryProfileUrlStringRepresents the name of the Dow Jones Country Profile Document.
CityStringThe city component of the address.
CountryCodeStringThe country code for the address.

WatchlistEntityAliasData

Property NameTypeDescription
NameStringThe name of the alias.
SingleStringNameStringThe single string name of the alias.
OriginalScriptNameStringThe name of the alias in its original script if available.
AliasTypeWatchlistAliasTypeEnumThe type of alias. See below for further details.

WatchlistAliasTypeEnum

Enumeration NameValueDescription
PrimaryAlias1The alias is the primary alias of the record.
AlsoKnownAs2The record is also known as this alias.
FormerlyKnownAs3The record was formerly known by this alias.
NowKnownAs4The record is now known by this alias.
Unknown5The type of alias is unknown.
MaidenName6The alias is a maiden name of the record.
SpellingVariation7The alias a spelling variation of another alias.
LowQualityAlsoKnownAs8The alias is record is also known by this alias, but the reliability of this information may be poor.

WatchlistAssociateData

Property NameTypeDescription
NameStringThe name of the associate.
ProfileIdStringThe Profile Id of the associate.
RelationshipStringThe relationship the associate has to the record.
ExBooleanWhether or not the associate is an ex-associate.

WatchlistBirthPlaceData

Property NameTypeDescription
BirthPlaceStringThe birthplace of the record.

WatchlistClassificationData

Property NameTypeDescription
WatchlistClassificationStringThe main classification, usually Politically Exposed Person (PEP), Relative or Close Associate (RCA), Special Interest Person (SIP), or Special Interest Entity (SIE).
ListClassificationStringThe list classification. This depends on the WatchlistClassification. It usually indicates a type of crime or a list the record belongs to that is relevant to the WatchlistClassification.
SubListClassificationStringThe sub classification. This depends on the ListClassification. It is usually a more specific classification, for example a specific crime.

WatchlistCountryData

Property NameTypeDescription
CountryCodeStringThe country code.
CountryNameStringThe name of the country.
CountryTypeStringThe type of relationship with the country. For example, the record could be a resident.

WatchlistDateEventData

Property NameTypeDescription
DayIntegerThe day the event occurred.
MonthIntegerThe month the event occurred.
YearIntegerThe year the event occurred.
NotesStringAny notes associated with the date event.
DateTypeStringThe type of event, e.g. date of birth, date of resignation, etc.

WatchlistGenderEnum

Enumeration NameValueDescription
Unknown0The record's gender is unknown or unspecified.
Male1The record's gender is Male.
Female2The record's gender is Female.

WatchlistIdentifierData

Property NameTypeDescription
IDTypeStringThe type of identifier. This is usually a document identifier such as company number, passport number, etc.
ValueStringThe value of the identifier. This is the actual value of the IDType, such as the actual passport number.
NotesIntegerAny notes associated with the identifier.

WatchlistImageData

Property NameTypeDescription
ImageURLStringThe URL of an image associated with the record.

MatchTypeEnum

Enumeration NameValueDescription
Person1The match is a Person.
Entity2The match is an Entity.
Unknown3The match is of unknown type. This may represent missing data and does not necessarily mean 'other'.
Vessel4The match is a vessel (usually maritime).
Aircraft5The match is an aircraft.

WatchlistSanctionData

Property NameTypeDescription
RoleTypeNameStringThe type of the role, usually primary occupation, other role, or previous role.
SinceDayIntegerThe day the occupation began.
SinceMonthIntegerThe month the occupation began.
SinceYearIntegerThe year the occupation began.
ToDayIntegerThe day the occupation ended.
ToMonthIntegerThe month the occupation ended.
ToYearIntegerThe year the occupation ended.
OccupationNameStringThe name of the occupation.
TitleStringThe title the record holds. If the record is deceased this may sometimes be indicated here.

WatchlistSourceData

Property NameTypeDescription
SourceStringThe source used to obtain data about the record. Usually a URL or document name.

WatchlistVesselData

Property NameTypeDescription
VesselCallSignStringThe call sign of the vessel.
VesselTypeStringThe type of vessel.
VesselTonnageStringThe tonnage of the vessel.
VesselGRTStringThe gross register tonnage (GRT) of the vessel.
VesselOwnerStringThe owner of the vessel.
VesselFlagStringThe flag belonging to the vessel.

PEP and Sanctions 006 Details Response

Example Response of PEP and Sanctions 006 Details:

"w2DataPepAndSanction006DetailsResult": {
                "addresses": [],
                "aka": "",
                "aliases": [],
                "countryName": "Korea, Democratic People's Republic Of",
                "directId": "49cbbbe4-c838-4a45-8f76-79b9644f5f11",
                "dob": "January 08, 1984",
                "dob2": "January 08, 1983",
                "effectiveDate": "2016",
                "entryCategory": "PEP",
                "entryDesc": "Individual",
                "firstName": "Jong-un",
                "govDesignation": "",
                "lastName": "Kim",
                "levelDesc": "N/A",
                "masterId": 0,
                "name": "Kim, Jong-un",
                "nationalId": "",
                "otherId": "",
                "passportId": "",
                "pob": "Pyongyang, North Korea",
                "positions": "Sanctioned Entity. Supreme Leader of North Korea, effective from December 17, 2011.",
                "prefix": "",
                "primaryName": "김정은",
                "profileId": "WC225108553",
                "relatedId": 0,
                "relationships": [],
                "remarks": "According to bbc.com; July 6, 2016: Kim Jong-un has been imposed sanctions for human rights abuses by the US Treasury. Kim was named as directly responsible for violations in North Korea which is already under an extensive sanctions regime for its nuclear",
                "sourceName": "Website",
                "subCatDesc": "Govt Branch Member",
                "suffix": "",
                "touchDate": "2019-08-02T10:02:34.443",
                "watch": false
            }

PEP and Sanctions 006 response breakdown

Property NameTypeDescription
AddressesString[]List of addresses
AkaStringNickname
AliasesString[]List of alternative names
CountryNameStringCountry
DirectIdStringOriginal supplier ID
DOBStringDate of birth
DOB2StringSecond date of birth
EffectiveDateStringDate that record became active
EntryCategoryStringCategory of record
EntryDescStringType of entity
ExpirationDateStringDate of record expiry
FirstNameStringFirst name
GovDesignationStringCategorisation of record as given by the regulatory body
LastNameStringLast name
LevelDescStringLevel of exposure for the PEP
MasterIdStringProfile ID for consolidated sanctions profiles
NameStringFull name
NationalIdStringNational ID number
OrganizationStringOrganisation that entity belongs to
OtherIdStringIdentification value for other unique forms of identification offered by countries
PassportIdStringPassport number
PictureFileStringIndicates if a picture is available
PobStringPlace of birth
PositionsStringPositions held
PrefixStringTitle, i.e. "Mr"
PrimaryNameStringOriginal, non-Romanized name
ProfileIdStringProfile ID
RelatedIdStringIndicates that relationships exist with other entities
RelationshipsStringLists relationships with other entities. These contain the following values: Is (string): Nature of relationship ToName (string): Name of relation ToProfileId (string): Profile ID of relation
RemarksStringAny additional miscellaneous information
SourceNameStringSource where entry originated
SourceWebLink(Deprecated)StringURL of information source (Deprecated)
SourceWebLinksStringURL of information source
SubCatDescStringRecord sub-category
SuffixStringName suffix
TouchDateStringLast date of change to record
WatchStringIndicates that there is negative news about the PEP

Sandbox


Example Request - Profile Details

{
    "Bundle": "KYC_ProfileDetails",
    "Data": {
        "NameQuery": "David Cameron"
    },
    "Options": {
        "Sandbox": "true"
    },
    "ClientReference": "your-client-reference"
}

To use sandbox the following example request can be used.
Remember to include the W2 provided API key in the Authorization Header.


If the Sandbox query option is set to "true" the following entry will be returned in the ServiceResult:

Example Response for "DIR-123456789":

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

If the ProfileId is entered as "DIR-123456789":

The DirectorUKDetailsResult will return the results of a ficticious director.


Example Response for "69e10264-4b90-64fe-b4b7-c9dddafd0241":

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

If the ProfileId is entered as "69e10264-4b90-64fe-b4b7-c9dddafd0241":

The WatchlistDetailsResult will return the results of John Smith that match the actual ProfileDetails service, but with associations, identifiers, occupations, profile notes, sanctions, and sources curtailed.


Example Response for "cb5f2851-64c0-6866-0ed1-da306e45efb2":

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

If the ProfileId is entered as "cb5f2851-64c0-6866-0ed1-da306e45efb2":

The WatchlistDetailsResult will return the results of John Smith that match the actual ProfileDetails service, but with associations, identifiers, occupations, profile notes, sanctions, and sources curtailed.


Example Response for "79bb61cd-6dca-b477-d688-c41947e11c4f":

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

If the ProfileId is entered as "79bb61cd-6dca-b477-d688-c41947e11c4f":

The PEPDeskDetailsResult will return the results of David Cameron that match the actual ProfileDetails service, but with functions curtailed.


Example Response for "SANC-a39a68a8-f82b-df96-f880-dedcafc2f1fb":

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

If the ProfileId is entered as "SANC-a39a68a8-f82b-df96-f880-dedcafc2f1fb":
The SPFPlusDetailsResult will return the results of David Cameron that match the actual ProfileDetails service.


Example Response for "SANC-cbe61692-1455-5cb6-879f-03864696e457":

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

If the ProfileId is entered as "SANC-cbe61692-1455-5cb6-879f-03864696e457":
The SISPlusDetailsResult will return the results of John Smith that match the actual ProfileDetails service.
The corresponding ServiceTransactions will show the following properties:


PEP and Sanction 006
The following profile ID's will give PEP and Sanction 006 profile details responses in sandbox mode:

  • WC49767
  • WC66266
  • WC191511
  • WC209189
  • WC401565
  • WC1868226
  • WC1980603
  • WC2320427
  • WC7064012
  • WC7245560
  • WC7310683
  • WC225000086

Example ServiceTransactions Result

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

The corresponding ServiceTransactions will show the following properties:

Example ServiceTransactions Result

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

For all other ProfileIDs:
An empty, non-null results will be returned.