JOjoincandidhealth
v3

Upload provider attachment

Changed on

Uploads a file to the provider. Accepted file types are W9, PECOS_RECORD, and BANK_LETTER_OR_VOIDED_CHECK. Only one file per type is allowed per provider — uploading when a file of the same type already exists returns a 409.

put/api/organization-providers/v3/{organization_provider_id}/attachments

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/organization-providers/v3/{organization_provider_id}/attachments
  • Auth
    HTTP bearer

Path parameters

organization_provider_idstring uuid required

Request body multipart/form-data

attachment_filestring binary required

The file to upload.

file_type'W9' | 'PECOS_RECORD' | 'BANK_LETTER_OR_VOIDED_CHECK' required

Response

Response with status 200

string uuid required

Changes

  • 24b2d80d577aRevision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the response's body type changed from no type to string, and format from no format to uuid for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      for the path request parameter organization_provider_id, the type was generalized from no type to string, and format from no format to uuid

    • info

      added the new BANK_LETTER_OR_VOIDED_CHECK enum value to the request property

    • info

      added the new PECOS_RECORD enum value to the request property

    • info

      added the new W9 enum value to the request property

    • info

      the request property type was generalized from no type to string

  • 3a81ee81d4edRevision changes
    • info

      api operation id upload_attachment removed and replaced with v3_upload_attachment