Title & Registration - Notifications - Sandbox

Title & Registration - Notifications

1.0.0OAS 3.0

Sends asynchronous event notifications on status changes for submitted title and registration transactions.

API Base URL
  • Server 1:https://api-test.vitu.com/national-public-api/v2
Security
keycloak (oauth2)

Client Credentials OAuth Flow

Token URL: https://auth.test.vitu.com/realms/api/protocol/openid-connect/token

Scopes:

  • oneapi:access - Allow access to this API via Keycloak
Additional Information

Notification

Get Subscription

Get Subscription.

get
https://api-test.vitu.com/national-public-api/v2/subscription

Query Parameters

limitinteger

Maximum items per page

Default:20

>= 1<= 100

offsetinteger

Items to skip

Default:0

>= 0

Response

application/json

OK

callbackUrlstring(uri)

Match pattern:^https://

<= 500 characters

get/subscription
 
application/json

Subscribe

Subscribe to transactions notifications. Any subsequent calls will modify callbackUrl. To receive notifications, use a webhook and process POST requests that API sends to that endpoint. For more information about structure of notification, please see SuccessCallbackDTO and FailureCallbackDTO. After you receive a notification, return a HTTP status code. To acknowledge, please return any 2xx code. In case of nack, API will try to send notification at most 3 times with exponential backoff starting from 1s.

put
https://api-test.vitu.com/national-public-api/v2/subscription

Query Parameters

callbackUrlstring(uri)required

URL to endpoint which will listen to transactions updates. Must be resolvable

Match pattern:^https://

<= 500 characters

Example:https://vitu.com/callback

Response

application/json

Successfully subscribed

object
put/subscription
 
application/json

Unsubscribe

Unsubscribe to transactions updates

delete
https://api-test.vitu.com/national-public-api/v2/subscription

Response

application/json

Successfully unsubscribed

object
delete/subscription
 
application/json