Profile Details

Compatible Cases

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 Name	Type	Mandatory	Notes
ProfileID	String	🔒	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 Name	Type	Description
Address1	String	First line of address.
Address2	String	Second line of address.
Address3	String	Third line of address.
Address4	String	Fourth line of address.
Address5	String	Fifth line of address.
BirthDate	String	Date of birth in a 'dd/MM/yyyy' format.
DirectorNumber	String	Number of director.
Directorships	Directorships	List of directorships held by director. See below.
Honours	String	Honours held by director.
Name	String	Name of director.
Nationality	String	Nationality of director.
Postcode	String	Postcode of director.
Title	String	Title 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 Name	Type	Description
AdditionalInformation	String
Country	String
DateOfBirth	String
FunctionDetails	PEPDeskFunctionDetails	See below
Gender	String
NameDetails	PEPDeskNameDetails	See below
PlaceOfBirth	String

PEPDeskFunctionDetails

Property Name	Type	Description
Function	String
SpecificFunction	String
Category	String
DateNotInchargeSince	String
ExPEP	Boolean

PEPDeskNameDetails

Property Name	Type	Description
Title	String
FirstName	String
LastName	String
FullName	String
OtherName	String
AlternativeScript	String

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 Name	Type	Description
NameDetails	SanctionsPlusNameDetails	See below.
Eyes	String
Hair	String
Weight	String
Height	String
Marks	String
Sex	String
Languages	String
TIN	String
Documents	String
PlaceOfBirth	String
DateOfBirth	String
Citizenship	String
Phone	String
Fax	String
Email	String
Website	String
Constituancy	String
PoliticalParty	String
ImageURL	String
PageURL	String
Source	String
Type	String
Offense	String
WantedBy	String
Program	String
LegalBasis	String
ListingDate	String
Callsign	String
VesselType	String
Tonnage	String
GRT	String
VesselFlag	String
VesselOwner	String
Remarks	String
AddressDetails	SanctionsPlusAddressDetails	See below.
AliasDetails	SanctionsPlusAliasDetails	See below.
RiskCode	String
Active	Boolean
Timestamp	DateTime

Sanctions Plus Name Details

Property Name	Type	Description
FullName	String
CourtesyTitle	String
FirstName	String
MiddleName	String
LastName	String
Suffix	String
Title	String

Sanctions Plus Address Details

Property Name	Type	Description
Address	String
City	String
Province	String
Postcode	String
Country	String
AddressRemarks	String

Sanctions Plus Alias Details

Property Name	Type	Description
AliasType	String
AliasName	String

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 Name	Type	Description
Action	WatchlistActionStatusEnum	The last action that was performed on the record. See below for more information.
ActionDate	String	The date the last action was performed on the record.
ActiveStatus	WatchlistActiveStatusEnum	Whether or not the record is marked as active. See below for more information.
Addresses	WatchlistAddressData	The addresses of the record. See below for details.
Aliases	WatchlistEntityAliasData	The aliases of the record. See below for details.
Associations	WatchlistAssociateData	The known associates of the record. See below for details.
BirthPlaces	WatchlistBirthPlaceData	Information about the birth places of the record. See below for details.
Classifications	WatchlistClassificationData	The classifications of the record. See below for details.
Countries	WatchlistCountryData	The countries associated with the record. See below for details.
DateEvents	WatchlistDateEventData	The dates of key events related to the record. See below for details.
Deceased	Boolean	Whether or not the record is deceased.
Gender	WatchlistGenderEnum	The gender of the record. See below for details.
Identifiers	WatchlistIdentifierData	Any identifiers associated with the record. See below for details.
Images	WatchlistImageData	Any images associated with the record. See below for details.
MatchType	MatchTypeEnum	The type of record. See below for details.
Occupations	WatchlistOccupationData	The occupations associated with the record. See below for details.
PrimaryAlias	String	The primary alias of the record.
ProfileId	String	The unique Profile Id for this record.
ProfileNotes	String	Additional notes associated with the record.
Sanctions	WatchlistSanctionData	The sanctions that apply to this record. See below for details.
Sources	WatchlistSourceData	The sources the information about this record is derived from.
Vessels	WatchlistVesselData	Any vessels (usually maritime) associated with the record. See below for details.

WatchlistActionStatusEnum

Enumeration Name	Value	Description
Delete	1	Represents a delete action.
Change	2	Represents a change action.
Add	3	Represents an add action.

WatchlistActiveStatusEnum

Enumeration Name	Value	Description
Active	1	The record is active.
Inactive	2	The record is inactive.

WatchlistAddressData

Property Name	Type	Description
AddressLine	String	The first line of the address, usually house number, street name, PO Box, etc.
CountryProfileUrl	String	Represents the name of the Dow Jones Country Profile Document.
City	String	The city component of the address.
CountryCode	String	The country code for the address.

WatchlistEntityAliasData

Property Name	Type	Description
Name	String	The name of the alias.
SingleStringName	String	The single string name of the alias.
OriginalScriptName	String	The name of the alias in its original script if available.
AliasType	WatchlistAliasTypeEnum	The type of alias. See below for further details.

WatchlistAliasTypeEnum

Enumeration Name	Value	Description
PrimaryAlias	1	The alias is the primary alias of the record.
AlsoKnownAs	2	The record is also known as this alias.
FormerlyKnownAs	3	The record was formerly known by this alias.
NowKnownAs	4	The record is now known by this alias.
Unknown	5	The type of alias is unknown.
MaidenName	6	The alias is a maiden name of the record.
SpellingVariation	7	The alias a spelling variation of another alias.
LowQualityAlsoKnownAs	8	The alias is record is also known by this alias, but the reliability of this information may be poor.

WatchlistAssociateData

Property Name	Type	Description
Name	String	The name of the associate.
ProfileId	String	The Profile Id of the associate.
Relationship	String	The relationship the associate has to the record.
Ex	Boolean	Whether or not the associate is an ex-associate.

WatchlistBirthPlaceData

Property Name	Type	Description
BirthPlace	String	The birthplace of the record.

WatchlistClassificationData

Property Name	Type	Description
WatchlistClassification	String	The main classification, usually Politically Exposed Person (PEP), Relative or Close Associate (RCA), Special Interest Person (SIP), or Special Interest Entity (SIE).
ListClassification	String	The 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.
SubListClassification	String	The sub classification. This depends on the ListClassification. It is usually a more specific classification, for example a specific crime.

WatchlistCountryData

Property Name	Type	Description
CountryCode	String	The country code.
CountryName	String	The name of the country.
CountryType	String	The type of relationship with the country. For example, the record could be a resident.

WatchlistDateEventData

Property Name	Type	Description
Day	Integer	The day the event occurred.
Month	Integer	The month the event occurred.
Year	Integer	The year the event occurred.
Notes	String	Any notes associated with the date event.
DateType	String	The type of event, e.g. date of birth, date of resignation, etc.

WatchlistGenderEnum

Enumeration Name	Value	Description
Unknown	0	The record's gender is unknown or unspecified.
Male	1	The record's gender is Male.
Female	2	The record's gender is Female.

WatchlistIdentifierData

Property Name	Type	Description
IDType	String	The type of identifier. This is usually a document identifier such as company number, passport number, etc.
Value	String	The value of the identifier. This is the actual value of the IDType, such as the actual passport number.
Notes	Integer	Any notes associated with the identifier.

WatchlistImageData

Property Name	Type	Description
ImageURL	String	The URL of an image associated with the record.

MatchTypeEnum

Enumeration Name	Value	Description
Person	1	The match is a Person.
Entity	2	The match is an Entity.
Unknown	3	The match is of unknown type. This may represent missing data and does not necessarily mean 'other'.
Vessel	4	The match is a vessel (usually maritime).
Aircraft	5	The match is an aircraft.

WatchlistSanctionData

Property Name	Type	Description
RoleTypeName	String	The type of the role, usually primary occupation, other role, or previous role.
SinceDay	Integer	The day the occupation began.
SinceMonth	Integer	The month the occupation began.
SinceYear	Integer	The year the occupation began.
ToDay	Integer	The day the occupation ended.
ToMonth	Integer	The month the occupation ended.
ToYear	Integer	The year the occupation ended.
OccupationName	String	The name of the occupation.
Title	String	The title the record holds. If the record is deceased this may sometimes be indicated here.

WatchlistSourceData

Property Name	Type	Description
Source	String	The source used to obtain data about the record. Usually a URL or document name.

WatchlistVesselData

Property Name	Type	Description
VesselCallSign	String	The call sign of the vessel.
VesselType	String	The type of vessel.
VesselTonnage	String	The tonnage of the vessel.
VesselGRT	String	The gross register tonnage (GRT) of the vessel.
VesselOwner	String	The owner of the vessel.
VesselFlag	String	The 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 Name	Type	Description
Addresses	String[]	List of addresses
Aka	String	Nickname
Aliases	String[]	List of alternative names
CountryName	String	Country
DirectId	String	Original supplier ID
DOB	String	Date of birth
DOB2	String	Second date of birth
EffectiveDate	String	Date that record became active
EntryCategory	String	Category of record
EntryDesc	String	Type of entity
ExpirationDate	String	Date of record expiry
FirstName	String	First name
GovDesignation	String	Categorisation of record as given by the regulatory body
LastName	String	Last name
LevelDesc	String	Level of exposure for the PEP
MasterId	String	Profile ID for consolidated sanctions profiles
Name	String	Full name
NationalId	String	National ID number
Organization	String	Organisation that entity belongs to
OtherId	String	Identification value for other unique forms of identification offered by countries
PassportId	String	Passport number
PictureFile	String	Indicates if a picture is available
Pob	String	Place of birth
Positions	String	Positions held
Prefix	String	Title, i.e. "Mr"
PrimaryName	String	Original, non-Romanized name
ProfileId	String	Profile ID
RelatedId	String	Indicates that relationships exist with other entities
Relationships	String	Lists 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
Remarks	String	Any additional miscellaneous information
SourceName	String	Source where entry originated
SourceWebLink(Deprecated)	String	URL of information source (Deprecated)
SourceWebLinks	String	URL of information source
SubCatDesc	String	Record sub-category
Suffix	String	Name suffix
TouchDate	String	Last date of change to record
Watch	String	Indicates 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":

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.