> ## 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.

# Address History

> Retrieves a user's verified address verification history with pagination support.



## OpenAPI

````yaml /api-reference/specs/quickcheck.json get /v2/api/addresses/history
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/history:
    get:
      tags:
        - KYC - Address Verification (Individuals)
        - KYB - Nigeria
      summary: Address History
      description: >-
        Retrieves a user's verified address verification history with pagination
        support.
      operationId: addressHistoryIndividual
      parameters:
        - name: token
          in: header
          required: true
          schema:
            type: string
          description: API secret token
        - name: page
          in: query
          required: false
          schema:
            type: string
          description: 'Page number (default: 1)'
        - name: limit
          in: query
          required: false
          schema:
            type: string
          description: 'Number of addresses to return (default: 20, max: 100)'
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                success: true
                statusCode: 200
                message: Addresses retrieved successfully!
                data:
                  docs:
                    - candidate:
                        candidateId: 618e7f4b48fe5f0ee26d5667
                        firstName: Famous
                        middleName: Prior
                        lastName: Ehichioya
                        photo: >-
                          https://youverify-api-bucket.nyc3.digitaloceanspaces.com/reports/live_photos/2021-11-12/photo_618e7f54be210c9056.jpg
                        email: famous@youverify.co
                        mobile: '08030000000'
                      address:
                        latlong:
                          lat: null
                          lon: null
                        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: 618e7f5cb9c42
                      status: pending
                      taskStatus: PENDING
                      businessType: admin
                      businessId: 615c2deb203b96532838418b
                      userId: 615c2deb203b96532838418c
                      type: individual
                      createdAt: '2021-11-12T14:51:19.525Z'
                      lastModifiedAt: '2021-11-12T14:51:19.525Z'
                      verificationId: 618e7f5cb9c42
                      id: 618e7f6748fe5f0ee26d5668
                      user:
                        firstName: Famous
                        lastName: Ehichioya
                        middleName: Prior
                        email: test@gmail.com
                        mobile: '+2348036000000'
                        countryCode: NG
                        id: 615c2deb203b96532838418c
                  pagination:
                    totalDocs: 11
                    perPage: 1
                    totalPages: 11
                    currentPage: 1
                    serialNo: 1
                    hasPrevPage: false
                    hasNextPage: true
                    prevPage: null
                    nextPage: 2
                links: []
        '401':
          $ref: '#/components/responses/Error401Unauthorized'
        '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: {}
    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.

````