GET
/
piirequest
/
{scopeRequestId}
curl --request GET \
  --url https://api.civic.com/partner/piirequest/{scopeRequestId}
{
  "status": "awaiting-user",
  "verifiedInformation": {
    "email": "user@example.com",
    "documentType": "passport",
    "issueCountry": "GBR",
    "name": "First Middle Last",
    "dateOfBirth": "1990-01-01",
    "dateOfExpiry": "2035-05-28",
    "documentNumber": "0123456789",
    "address": "0x1234abcd"
  },
  "links": [
    {
      "rel": "idDocumentFront",
      "href": "https://api.civic.com/partner/piirequest/9a7a77af-a58e-4e54-83c9-5daa96ccbf11"
    }
  ]
}

Path Parameters

scopeRequestId
string
required

The ID that was provided to you by Civic after the user has submitted their PII

Response

200 - application/json

OK

The response is of type object.