> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update associated person proof-of-address

> Update the proof-of-address process for an associated person.

export const RestEndpointSubjects = ({subjects = []}) => {
  const subjectToIconMap = {
    'client': 'browser',
    'user:individual': 'user',
    'user:business': 'briefcase'
  };
  if (subjects.length === 0) {
    return null;
  }
  return <>
      {subjects.map(subject => <a key={subject} href="/rest-apis/authentication#subjects" className="border-0 opacity-85 hover:opacity-100 transition-opacity">
          <Badge stroke size="lg" icon={subjectToIconMap[subject]} color="gray" className="mr-1">
            {subject}
          </Badge>
        </a>)}
    </>;
};

<RestEndpointSubjects subjects={["user:business"]} />

<Warning>This endpoint is not yet available in **Sandbox** or **Production**.</Warning>

**Update associated person proof-of-address** verifies the residential address of an individual tied to the business, through a supporting document such as a utility bill or a bank statement.

More information will be supplied once this endpoint is complete.


## OpenAPI

````yaml _media/specs/core-openapi.mintlify.json patch /core/kyb/associated-persons/{personId}/processes/proof-of-address
openapi: 3.1.0
info:
  version: 0.1.0
  title: Core API
  description: >-
    The Core API provides essential building blocks that empower businesses to
    embed financial services into their applications.
  contact:
    name: Uphold API Team
    email: developers@uphold.com
    url: https://developer.uphold.com
servers:
  - url: https://api.enterprise.sandbox.uphold.com
    description: Sandbox
  - url: https://api.enterprise.uphold.com
    description: Production
security:
  - OAuth2: []
tags:
  - name: Authentication
    description: Authentication.
  - name: Countries
    description: Countries.
  - name: Users
    description: Users.
  - name: KYC
    description: Individual User's KYC.
  - name: KYB
    description: Business User's KYB.
  - name: Capabilities
    description: User capabilities.
  - name: Terms of service
    description: User terms of service.
  - name: Files
    description: Files.
  - name: Assets
    description: Assets, networks and rails.
  - name: Accounts
    description: Accounts.
  - name: External accounts
    description: External accounts.
  - name: Transactions
    description: Transactions.
  - name: Portfolio
    description: Portfolio.
  - name: Statements
    description: Statements.
  - name: Metadata
    description: Metadata.
  - name: Webhooks
    description: Webhooks.
paths:
  /core/kyb/associated-persons/{personId}/processes/proof-of-address:
    patch:
      tags:
        - KYB
      summary: Update associated person proof-of-address
      description: Update the proof-of-address process for an associated person.
      operationId: core.update-kyb-associated-person-proof-of-address
      parameters:
        - $ref: '#/components/parameters/kyb-associated-person-id'
      requestBody:
        $ref: >-
          #/components/requestBodies/update-kyb-associated-person-proof-of-address-request
      responses:
        '200':
          $ref: >-
            #/components/responses/update-kyb-associated-person-proof-of-address-response
        '404':
          $ref: >-
            #/components/responses/update-kyb-associated-person-proof-of-address-not-found-response
        '409':
          $ref: >-
            #/components/responses/update-kyb-associated-person-proof-of-address-conflict-response
      security:
        - OAuth2:
            - core.kyb.associated-persons.proof-of-address:update
components:
  parameters:
    kyb-associated-person-id:
      name: personId
      in: path
      description: The unique identifier of the associated person.
      required: true
      schema:
        type: string
        format: uuid
  requestBodies:
    update-kyb-associated-person-proof-of-address-request:
      content:
        application/json:
          schema:
            type: object
            properties:
              type:
                description: The proof-of-address submission type.
                type: string
                enum:
                  - document-submission
              input:
                description: Input of the proof-of-address process.
                type: object
                properties:
                  media:
                    description: The media that was used to verify the address.
                    type: array
                    minItems: 1
                    maxItems: 5
                    items:
                      type: object
                      properties:
                        context:
                          description: The context of the file.
                          type: string
                          enum:
                            - address-proof
                        fileId:
                          description: The id of the file.
                          type: string
                          format: uuid
                      required:
                        - context
                        - fileId
                required:
                  - media
            required:
              - type
              - input
          examples:
            Update Process:
              value:
                type: document-submission
                input:
                  media:
                    - context: address-proof
                      fileId: 459c0447-8916-4bad-bb67-f2354fcfb10b
  responses:
    update-kyb-associated-person-proof-of-address-response:
      description: Associated person proof-of-address updated successfully.
      content:
        application/json:
          schema:
            type: object
            properties:
              proofOfAddress:
                $ref: '#/components/schemas/kyb-associated-person-proof-of-address'
            required:
              - proofOfAddress
          examples:
            Process Updated:
              value:
                proofOfAddress:
                  code: proof-of-address
                  status: running
                  type: document-submission
                  input:
                    media:
                      - context: address-proof
                        fileId: 459c0447-8916-4bad-bb67-f2354fcfb10b
      headers:
        x-uphold-request-id:
          description: >-
            A unique identifier for the request that can be shared with Uphold
            for troubleshooting purposes.
          required: true
          schema:
            type: string
            format: uuid
          examples:
            Request ID:
              value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
    update-kyb-associated-person-proof-of-address-not-found-response:
      description: Associated person not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            Associated Person Not Found:
              value:
                code: entity_not_found
                message: The associated person cannot be found
                details:
                  context: path
                  entity: associated-person
                  property: personId
      headers:
        x-uphold-request-id:
          description: >-
            A unique identifier for the request that can be shared with Uphold
            for troubleshooting purposes.
          required: true
          schema:
            type: string
            format: uuid
          examples:
            Request ID:
              value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
    update-kyb-associated-person-proof-of-address-conflict-response:
      description: Business logic error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
          examples:
            File Invalid:
              value:
                code: file_invalid
                message: A file specified in the media array has not been uploaded
                details:
                  context: body
                  property: input.media
            File Not Found:
              value:
                code: entity_not_found
                message: A file specified in the media array cannot be found
                details:
                  entity: file
            Process Updates Not Allowed:
              value:
                code: operation_not_allowed
                message: The current status of the process does not allow updates
                details:
                  reasons:
                    - kyb-process-update-not-allowed
      headers:
        x-uphold-request-id:
          description: >-
            A unique identifier for the request that can be shared with Uphold
            for troubleshooting purposes.
          required: true
          schema:
            type: string
            format: uuid
          examples:
            Request ID:
              value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
  schemas:
    kyb-associated-person-proof-of-address:
      type: object
      discriminator:
        propertyName: type
        mapping:
          none:
            $ref: '#/components/schemas/kyb-associated-person-proof-of-address-none'
          document-submission:
            $ref: >-
              #/components/schemas/kyb-associated-person-proof-of-address-document-submission
      oneOf:
        - $ref: '#/components/schemas/kyb-associated-person-proof-of-address-none'
          title: None
        - $ref: >-
            #/components/schemas/kyb-associated-person-proof-of-address-document-submission
          title: Document submission
    error:
      description: The error information.
      allOf:
        - $ref: '#/components/schemas/feedback'
    kyb-associated-person-proof-of-address-none:
      title: None
      description: The proof-of-address process for an associated person.
      type: object
      properties:
        code:
          description: The code of the KYB process.
          type: string
          const: proof-of-address
        status:
          $ref: '#/components/schemas/kyb-process-status'
        type:
          description: The proof-of-address submission type.
          type: string
          enum:
            - none
      required:
        - code
        - status
        - type
    kyb-associated-person-proof-of-address-document-submission:
      title: Document Submission
      description: The proof-of-address process for an associated person.
      type: object
      properties:
        code:
          description: The code of the KYB process.
          type: string
          const: proof-of-address
        status:
          $ref: '#/components/schemas/kyb-process-status'
        type:
          description: The proof-of-address submission type.
          type: string
          enum:
            - document-submission
        input:
          description: Input of the KYB process.
          type: object
          properties:
            media:
              description: The media that was used to verify the address.
              type: array
              items:
                type: object
                properties:
                  context:
                    description: The context of the file.
                    type: string
                    enum:
                      - address-proof
                  fileId:
                    description: The id of the file.
                    type: string
                    format: uuid
        output:
          description: Output of the KYB process.
          type: object
          properties:
            provider:
              description: The provider used to verify the KYB process.
              type: string
            reason:
              description: The reason associated with the verification.
              type: string
              enum:
                - address-mismatch
                - name-mismatch
            person:
              description: The person information.
              type: object
              properties:
                givenName:
                  description: The person's given name.
                  type: string
                familyName:
                  description: The person's family name or surname.
                  type: string
                address:
                  allOf:
                    - $ref: '#/components/schemas/address'
                    - type: object
                      required:
                        - country
              required:
                - givenName
                - address
            verifiedAt:
              description: The date and time of the verification.
              type: string
              format: date-time
          required:
            - provider
            - person
            - verifiedAt
      required:
        - code
        - status
        - type
    feedback:
      description: A feedback message with a code and human-readable description.
      type: object
      properties:
        code:
          description: A short string with a brief explanation about the code reported.
          type: string
        message:
          description: A human-readable message providing more details.
          type: string
        details:
          description: Additional information about the feedback reported.
          type: object
          additionalProperties: true
      required:
        - code
        - message
    kyb-process-status:
      description: Status of the KYB process.
      type: string
      enum:
        - ok
        - failed
        - running
        - pending
        - exempt
    address:
      description: The address information.
      type: object
      properties:
        country:
          description: The country of the address.
          type: string
        subdivision:
          description: The subdivision of the address.
          type: string
        city:
          description: The city of the address.
          type: string
        line1:
          description: The first line of the address.
          type: string
        line2:
          description: The second line of the address.
          type: string
        postalCode:
          description: The postal code of the address.
          type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth 2.0 authentication.
      flows:
        clientCredentials:
          tokenUrl: /core/oauth2/token
          scopes:
            core.users:act-on-behalf-of: Grants access to act on behalf of a user
            core.users:create: Grants access to create users
            core.users:read: Grants access to view users
            core.users:delete: Grants access to delete users
            core.users.metadata:read: Grants access to view user metadata
            core.users.metadata:write: Grants access to modify user metadata
            core.kyc:read: Grants access to view KYC processes
            core.kyc.profile:update: Grants access to update profile KYC process
            core.kyc.address:update: Grants access to update address KYC process
            core.kyc.email:update: Grants access to update email KYC process
            core.kyc.phone:update: Grants access to update phone KYC process
            core.kyc.identity:update: Grants access to update identity KYC process
            core.kyc.proof-of-address:update: Grants access to update proof-of-address KYC process
            core.kyc.customer-due-diligence:update: Grants access to update customer due diligence KYC process
            core.kyc.enhanced-due-diligence:update: Grants access to update enhanced due diligence KYC process
            core.kyc.crypto-risk-assessment:update: Grants access to update crypto risk assessment KYC process
            core.kyc.self-categorization-statement:update: Grants access to update self-categorization statement KYC process
            core.kyc.tax-details:update: Grants access to update tax details KYC process
            core.kyb:read: Grants access to view KYB processes
            core.kyb.profile:update: Grants access to update profile KYB process
            core.kyb.documents:update: Grants access to update documents KYB process
            core.kyb.financial-institution:update: Grants access to update financial institution KYB process
            core.kyb.associated-persons:create: Grants access to create KYB associated persons
            core.kyb.associated-persons:read: Grants access to view KYB associated persons
            core.kyb.associated-persons:delete: Grants access to delete KYB associated persons
            core.kyb.associated-persons.profile:update: Grants access to update profile KYB associated person process
            core.kyb.associated-persons.identity:update: Grants access to update identity KYB associated person process
            core.kyb.associated-persons.proof-of-address:update: >-
              Grants access to update proof-of-address KYB associated person
              process
            core.kyb.attestation:trigger: Grants access to trigger the attestation process
            core.capabilities:read: Grants access to view user capabilities
            core.terms-of-service:read: Grants access to view terms of service
            core.terms-of-service:accept: Grants access to accept terms of service
            core.files:create: Grants access to create files
            core.files:read: Grants access to view files
            core.files.metadata:read: Grants access to view files metadata
            core.files.metadata:write: Grants access to modify files metadata
            core.accounts:create: Grants access to create accounts
            core.accounts:read: Grants access to view accounts
            core.accounts:update: Grants access to update accounts
            core.accounts:archive: Grants access to archive accounts
            core.accounts:deposit-method: >-
              Grants access to deposit method needed for depositing into
              accounts
            core.accounts:use-test-helpers: Grants access to test helpers of accounts
            core.accounts.metadata:read: Grants access to view accounts metadata
            core.accounts.metadata:write: Grants access to modify accounts metadata
            core.assets:use-test-helpers: Grants access to test helpers of assets
            core.external-accounts:create: Grants access to create external accounts
            core.external-accounts:read: Grants access to view external accounts
            core.external-accounts:update: Grants access to update external accounts
            core.external-accounts:delete: Grants access to delete external accounts
            core.external-accounts.metadata:read: Grants access to view external accounts metadata
            core.external-accounts.metadata:write: Grants access to modify external accounts metadata
            core.transactions:create: Grants access to commit quotes
            core.transactions:read: Grants access to view transactions
            core.transactions.metadata:read: Grants access to view transactions metadata
            core.transactions.metadata:write: Grants access to modify transactions metadata
            core.transactions.requests-for-information:read: Grants access to view transactions requests for information
            core.transactions.requests-for-information:update: Grants access to update transactions requests for information
            core.portfolio:read: >-
              Grants access to view portfolio overview, performance, and
              historical balance
            core.statements:read: Grants access to read statements
            core.webhooks:management-link: Grants access to create webhook management links

````