GET /v1/verificationRequests/{verificationId}

Returns the current record of a verification created by Create a verification request or by Screening Only.

Before integrating

Five things to watch out for

1. The record returned is the current one, not the request as it was sent. Dates and pet values changed by Modify a verification request show as they are now, and a cancelled verification is still returned, with verification.isCancelled set to true.
2. The shape depends on how the verification was created. A verification request returns metadata, company, listing, reservation, guest, protection and verification. A screening returns metadata, guest and verification only, and its verification carries no isCancelled, because a screening cannot be cancelled.
3. A value that was not sent is omitted, never returned as null. A field that is absent from the response was not supplied. The one exception is protection.currency, which carries the account's currency when none was sent.
4. Values come back typed. listing.petsAllowed, protection.isPerStay, protection.hasPetProtection and verification.isCancelled are booleans, and the three listing counts are integers. Dates are yyyy-MM-dd.
5. There is no echo token. The request is the path and the Ocp-Apim-Subscription-Key header (no body, and no header or query parameter for a token), and metadata carries timeStamp only, on a success and on an error. The path also carries a /v1 prefix that the other operations do not: in the sandbox it is https://developer.api.truvi.com/screen-and-protect-sandbox/v1/verificationRequests/{verificationId}.

Request

No body, and no Content-Type. The subscription key goes in the Ocp-Apim-Subscription-Key header, as on every operation.

Path parameter

Example request

GET /v1/verificationRequests/9c1f7a20-5b84-4d6e-8a13-7f0c2b95e4d1
Ocp-Apim-Subscription-Key: <subscription key>

Response

200: The verification's current record. company, listing, reservation, protection and verification.isCancelled are absent for a screening-only verification; status is Approved, Rejected or Flagged, and flaggedReason is present only when status is Flagged.

200 is the only success code. A verification that was rejected, flagged or cancelled returns 200 like any other; the outcome is carried by verification.

metadata