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

# Request a Business Address Verification

> Endpoint for requesting business address verification after creating a candidate in the KYB (Know Your Business) system.



## OpenAPI

````yaml /api-reference/specs/quickcheck.json post /v2/api/addresses/business/request
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/business/request:
    post:
      tags:
        - KYB - Nigeria
      summary: Request a Business Address Verification
      description: >-
        Endpoint for requesting business address verification after creating a
        candidate in the KYB (Know Your Business) system.
      operationId: requestABusinessAddressVerificationBusiness
      parameters:
        - name: token
          in: header
          required: true
          schema:
            type: string
          description: API secret token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                candidateId:
                  type: string
                  description: Candidate ID
                subjectConsent:
                  type: boolean
                  description: Must be true
                description:
                  type: string
                  description: Information for the agent
                address:
                  type: object
                  description: Address details
                  properties:
                    flatNumber:
                      type: string
                      description: Flat number
                    buildingName:
                      type: string
                      description: Building name
                    buildingNumber:
                      type: string
                      description: Building number
                    landmark:
                      type: string
                      description: Address landmark
                    street:
                      type: string
                      description: Street name
                    subStreet:
                      type: string
                      description: Sub-street
                    state:
                      type: string
                      description: State
                    city:
                      type: string
                      description: City
                    lga:
                      type: string
                      description: Local government area
                  required:
                    - buildingNumber
                    - landmark
                    - street
                    - state
                    - city
                business:
                  type: object
                  description: Business details
                  properties:
                    name:
                      type: string
                      description: Business name
                    email:
                      type: string
                      description: Business email
                    mobile:
                      type: string
                      description: Business phone
                    registrationNumber:
                      type: string
                      description: Business registration number
                  required:
                    - name
                    - email
                    - mobile
                    - registrationNumber
                metadata:
                  type: object
                  description: Custom metadata object
              required:
                - candidateId
                - subjectConsent
                - address
                - business
            example:
              candidateId: 6184e3c081ee238921cb9e86
              description: Verify the candidate and business
              business:
                name: Youcheck Online Services Limited
                email: support@youverify.co
                mobile: 08036xxxxxx
                registrationNumber: '123456789'
              address:
                flatNumber: 1st floor
                buildingName: Sum house
                buildingNumber: '350'
                landmark: Police Station
                street: Borno way
                subStreet: Hughes avenue
                state: Lagos
                city: Yaba
                lga: Lagos Mainland
              subjectConsent: true
              metadata:
                requestId: '1209348756'
      responses:
        '201':
          description: Address requested successfully
          content:
            application/json:
              example:
                success: true
                statusCode: 201
                message: Address requested successfully!
                data:
                  candidate:
                    candidateId: 618e33dd0b96f3c4397332f1
                    firstName: FAMOUS
                    middleName: PRIOR
                    lastName: EHICHIOYA
                    photo: null
                    email: null
                    mobile: 08036xxxxxx
                  business:
                    name: Youcheck Online Services Limited
                    registrationNumber: '123456789'
                    email: support@youverify.co
                    mobile: '08036000000'
                  agent:
                    firstName: null
                    middleName: null
                    lastName: null
                    signature: null
                    photo: null
                  address:
                    latlong:
                      lat: '0'
                      lon: '0'
                    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: 61ba87d3b559f
                  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 and business
                  reportId: reports_23e42a91-28b3-4a45-9b12-2ae12a28c124
                  downloadUrl: null
                  businessType: organization
                  businessId: 619b683ecb55a2a588f4b83c
                  userId: 619b683ecb55a2a588f4b839
                  type: business
                  createdAt: '2021-12-16T00:27:07.801Z'
                  lastModifiedAt: '2021-12-16T00:27:07.801Z'
                  _createdAt: 2021-12-16T01:27:077+01:00
                  _lastModifiedAt: 2021-12-16T01:27:077+01:00
                  verificationId: 61ba87d3b559f
                  id: 61ba87dbf5e3a21724ad8219
                links: []
        '401':
          $ref: '#/components/responses/Error401Unauthorized'
        '402':
          description: Insufficient fund
          content:
            application/json:
              example:
                success: false
                statusCode: 402
                message: Insufficient fund
                name: PaymentRequiredError
                data: {}
        '403':
          description: Permission denied
          content:
            application/json:
              example:
                success: false
                statusCode: 403
                message: Permission denied
                name: UnauthorizedError
                data: {}
        '429':
          $ref: '#/components/responses/Error429TooManyRequests'
        '500':
          description: Service unavailable
          content:
            application/json:
              example:
                success: false
                statusCode: 500
                message: Service unavailable
                name: Error
                data: {}
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: {}
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: token
      description: Your Youverify API secret key. Never expose client-side.

````