Client package for the UwKluis APIs

1.1.12 2021-08-23 12:56 UTC


Latest Version on Packagist Software License Total Downloads

This package can assist in connecting to the UwKluis API. An OpenAPI compatible schema and Swagger -generated documentation about the individual endpoints can be found at the root of this domain.




Via Composer

$ composer require uwkluis/client


First setup the route and controller to handle the OAuth2 callback. Store the (data from the) token response in some fashion.

$config = new \UwKluis\Client\Organization\Config(
    ['read-person-data', 'read-write-mortgages-data']
$guzzleClient = new GuzzleHttp\Client();
$organizationConnect = new UwKluis\Client\Organization\Connect($config, $guzzleClient);
$accessTokenResponse = $organizationConnect->processResponse($psr7request);
$accessToken = $accessTokenResponse->getAccessToken();
$refreshToken = $accessTokenResponse->getRefreshToken();
$expiration = $accessTokenResponse->getExpiration();

Send organization users to the Oauth2 url to establish a connection. A request will be sent to the callback route in response.

/** @var $connect UwKluis\Client\Organization\Connect */
echo '<a href="' . $connect->getAuthorizeUrl() . '">Connect</a>';

A user can then have an invitation sent to the consumer based on their phone number and e-mail address. Your client now needs the previously stored access token. The resulting response object will contain the organization consumer id and the UFO consumer id (a UUID). Store these for future requests.

$organizationConsumerId = 'JOHNSON_AMSTERDAM_001';
$consumerConnect = new \UwKluis\Client\Consumer\Connect($config, $guzzleClient);
$connection = $consumerConnect->inviteConsumer('johnson@example.org', '0612345678');
$uwKluisConsumerId = $connection->getUwKluisConsumerId();

If the user's organization already has a connection, the request will fail, throwing a \UwKluis\Client\Exception\ConsumerConnectionConflict, which contains the conflicting connection. This can be extracted via \UwKluis\Client\Exception\ConsumerConnectionConflict::getConflictingConnection(). Information about an existing connection, such as one returned by the aforementioned exception, can be retrieved using:

 /** @var $consumerConnect \UwKluis\Client\Consumer\Connect */
 /** @var $token \Lcobucci\JWT\Token */
 /** @var $uwKluisConsumerId \Ramsey\Uuid\UuidInterface */
 /** @var $connection \UwKluis\Client\Consumer\Connect */
$connection = $consumerConnect->getConnectionStatus($token, $uwKluisConsumerId);

If an invitation has been sent to a consumer, but they are unable to accept it because either the phonenumber or the e-mail address are incorrect, or they are unable to find the invitation, one can send a new invitation using the existing connection ID:

/** @var $consumerConnect \UwKluis\Client\Consumer\Connect */
/** @var $token \Lcobucci\JWT\Token */
/** @var $uwKluisConsumerId \Ramsey\Uuid\UuidInterface */
$consumerConnect->updateAndReinviteConsumer($token, $uwKluisConsumerId, 'newEmail@example.org', '0612345678');

First request the current consumer dossier, using the organization's access token, the organization consumer id and the desired consumer dossier json schema version:

$dossier = new \UwKluis\Client\Consumer\Dossier($config, $guzzleClient);
$response = $dossier->getData(
$data = $response['data'];

If you wish to update the consumer dossier data, first merge the retrieved data with your own, and then send that back using the updateData() method.

/** @var array $mergedData */


The UwKluis API provides several webhook options, so your client can be notified if a consumer connection changes (for instance when a consumer establishes a connection, or changes the granted scopes) or when a consumer dossier changes (either by the consumer or by another client application or organization). Registering webhooks can be done after an organization user has established a connection using Oauth2. The uwkluis/webhook-client package can help implementing webhooks in your client application.


$ composer test


Please see CONTRIBUTING and CODE_OF_CONDUCT for details.


If you discover any security related issues, please email info@hypotheekbond.nl instead of using the issue tracker.


The MIT License (MIT). Please see License File for more information.