> ## Documentation Index > Fetch the complete documentation index at: https://doc.youverify.co/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve an Address Verification > Retrieves an address verification report by its address ID; the report status may be pending, completed (verified/not verified), or canceled. ## OpenAPI ````yaml /api-reference/specs/quickcheck.json get /v2/api/addresses/{addressId} openapi: 3.0.3 info: title: Youverify Quick Check API version: 2.0.0 description: >- All Quick Check endpoints (KYC identity verification by country, KYB business verification by country, and AML/watchlist screening). Assembled from doc.youverify.co/api-reference-sdk/api-reference/quick-check, endpoints kept in the exact order they appear in the GitBook navigation. Some endpoints (address-verification "create a candidate" / "get states" / "retrieve" / "history") are documented twice in the source docs — once for individuals under KYC, once for businesses under KYB — and are the exact same request/response shape. They appear ONCE here (at their first, KYC, position) tagged with both sections so the file stays valid OpenAPI. Account-wide error responses (401, 429, 500 on every endpoint; 402 on paid verification calls; 404 on lookup-by-ID calls) are sourced verbatim from Youverify's own "Youverify OS Error Codes" and "Response Codes" pages (doc.youverify.co/youverify-os-error-codes, /get-started/response-codes) and attached via components.responses, since those pages document them account-wide rather than per endpoint. Any error example that a specific endpoint's own page actually showed is kept exactly as documented there instead of being replaced by these. contact: name: Youverify Support email: support@youverify.co servers: - url: https://api.youverify.co description: Production (live, billed) - url: https://api.sandbox.youverify.co description: Sandbox (test data, not billed) security: - ApiKeyAuth: [] tags: - name: KYC - Global description: Identity data-matching endpoints that work across countries. - name: KYC - South Africa description: South Africa-specific identity, phone and bank verification. - name: KYC - Kenya description: Kenya-specific identity, phone, bank, credit and employment verification. - name: KYC - Ghana description: Ghana-specific identity verification (passport, SSNIT, voter's card). - name: KYC - Nigeria description: >- Nigeria-specific identity, phone, bank and credit verification (BVN, NIN, etc). - name: KYC - Cote D'Ivoire description: Cote D'Ivoire-specific national ID and residence card verification. - name: KYC - General description: >- Identity retrieval, history and facial comparison, not tied to one country. - name: KYC - Address Verification (Individuals) description: >- Physical and digital address verification workflows for individuals. Note: these same endpoints are also documented under KYB for businesses — see merge notes. - name: KYB - Global description: >- Business search, bulk-upload and premium company-search endpoints not tied to one country. - name: KYB - Nigeria description: Nigeria-specific business address verification and tax ID checks. - name: KYB - South Africa description: South Africa-specific business account and address verification. - name: KYB - Cote D'Ivoire description: Cote D'Ivoire-specific company filings lookup. - name: AML Screening description: PEP, sanctions, adverse-media and crypto AML screening. - name: AML Watchlist description: Manage your own custom AML watchlist. paths: /v2/api/addresses/{addressId}: get: tags: - KYC - Address Verification (Individuals) - KYB - Nigeria summary: Retrieve an Address Verification description: >- Retrieves an address verification report by its address ID; the report status may be pending, completed (verified/not verified), or canceled. operationId: retrieveAddressVerificationIndividual parameters: - name: token in: header required: true schema: type: string description: API secret token - name: addressId in: path required: true schema: type: string description: The address verification's ID responses: '200': description: Success (pending, verified, canceled, or not verified) content: application/json: example: success: true statusCode: 200 message: Address retrieved successfully! data: candidate: candidateId: 62973912fdc2225c65bb1302 firstName: John middleName: Michael lastName: Doe photo: >- https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2022-06-01/photo_6297396bc723f8246.png email: famous@youverify.co mobile: '08030000000' agent: firstName: null middleName: null lastName: null signature: null photo: null address: latlong: lat: '6.500871399999999' lon: '3.3765867' flatNumber: 1st floor buildingName: Sum house buildingNumber: '350' subStreet: Hughes avenue street: Borno way landmark: Police Station state: Lagos city: Yaba country: Nigeria lga: Lagos Mainland referenceId: 6297396cc0dea parentId: null status: pending taskStatus: PENDING subjectConsent: 'true' startDate: null endDate: null submittedAt: null executionDate: null completedAt: null acceptedAt: null revalidationDate: null notes: [] isFlagged: false agentSubmittedLongitude: null agentSubmittedLatitude: null reportGeolocationUrl: null mapAddressUrl: null submissionDistanceInMeters: null reasons: null signature: null images: [] buildingType: null buildingColor: null gatePresent: null gateColor: null availabilityConfirmedBy: null closestLandmark: null additionalInfo: null reportAgentAccess: null incidentReport: null description: Verify the candidate reportId: reports_f1b762e8-c65b-4efa-9e6c-4aad8f258013 downloadUrl: null apiVersion: v2 businessType: admin businessId: 61d880f1e8e15aaf24558f1a userId: 61d880f2e8e15aaf24558f9b type: individual metadata: {} createdAt: '2022-06-01T10:03:37.110Z' lastModifiedAt: '2022-06-01T10:03:37.110Z' verificationId: 6297396cc0dea id: 62973964fdc2225c65bb1303 user: firstName: Famous lastName: Ehichioya middleName: Prior email: developer@youverify.co mobile: '+2348036208556' countryCode: NG id: 61d880f2e8e15aaf24558f9b links: [] '401': $ref: '#/components/responses/Error401Unauthorized' '404': $ref: '#/components/responses/Error404NotFound' '429': $ref: '#/components/responses/Error429TooManyRequests' '500': $ref: '#/components/responses/Error500ServerError' components: responses: Error401Unauthorized: description: Unauthorized — the token header is missing or invalid. content: application/json: example: success: false statusCode: 401 message: Permission denied name: UnauthorizedError data: {} Error404NotFound: description: Not Found — the URL, or the resource ID in the URL, was not recognized. content: application/json: example: success: false statusCode: 404 message: Not found name: ResourceNotFoundError data: {} Error429TooManyRequests: description: Too Many Requests — you have exceeded the rate limit; wait and retry. content: application/json: example: success: false statusCode: 429 message: Too many requests name: RateLimitError data: {} Error500ServerError: description: >- Internal Server Error — a rare, unexpected failure on Youverify's side. Contact support@youverify.co if it persists. content: application/json: example: success: false statusCode: 500 message: Internal Server Error name: Error data: {} securitySchemes: ApiKeyAuth: type: apiKey in: header name: token description: Your Youverify API secret key. Never expose client-side. ````