GET PlanCare2Api/Clients/{clientId}/WidVerifications

Get the most recent WID verification of a client

At least one of these modules is required: RelationManagement

Requires 'Read' permission for function ClientWidVerification {73E78B2B-7F1A-4368-A7D2-9EE1A8CEC145}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	internal client identifier	integer	Required

Body Parameters

None.

Response Information

Resource Description

The most recent WidVerification for a relation

WidVerification

Name	Description	Type	Additional information
ById	Id of the relation who did the verification	integer	-
ByText	THe name of the relation who did the verification	string	-
Date	The date when the verification was done	date	-
Source	The verification source	RelationWidVerificationSourceEnum	-
SourceText	The verification source as text	string	-
DocumentType	The document type	<Nullable>RelationWidVerificationDocumentTypeEnum	-
DocumentTypeText	The document type as text	string	-
DocumentNumber	The document number	string	-
ValidUntil	The valid until	date	Nullable
Confirmed	Whether or not the verification is confirmed	boolean	-
DocumentInfoId	The document info id	integer	Nullable
DocumentFileName	The document filename (obsolete)	string	-

Response Formats

application/json, text/json

Sample:

{
  "ById": 1,
  "ByText": "sample string 2",
  "Date": "2026-05-26T21:11:50.0377415+02:00",
  "Source": 1,
  "SourceText": "sample string 4",
  "DocumentType": 1,
  "DocumentTypeText": "sample string 5",
  "DocumentNumber": "sample string 6",
  "ValidUntil": "2026-05-26T21:11:50.0377415+02:00",
  "Confirmed": true,
  "DocumentInfoId": 1,
  "DocumentFileName": "sample string 8"
}

application/xml, text/xml

Sample:

<WidVerification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DHS.PlanCare.Web.Api.Interface.Client">
  <ById>1</ById>
  <ByText>sample string 2</ByText>
  <Confirmed>true</Confirmed>
  <Date>2026-05-26T21:11:50.0377415+02:00</Date>
  <DocumentFileName>sample string 8</DocumentFileName>
  <DocumentInfoId>1</DocumentInfoId>
  <DocumentNumber>sample string 6</DocumentNumber>
  <DocumentType>Passport</DocumentType>
  <DocumentTypeText>sample string 5</DocumentTypeText>
  <Source>Wid</Source>
  <SourceText>sample string 4</SourceText>
  <ValidUntil>2026-05-26T21:11:50.0377415+02:00</ValidUntil>
</WidVerification>