Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Users

Add Consumer Profile Attachment – Uploads an attachment to a user's consumer profile.

Uploads an attachment to the specified user's consumer profile. The request must include the attachment data and metadata. Returns the result of the upload operation.

post/programs/{programCode}/users/{userIdentifier}/uploadAttachment

Path parameters

programCodestring required

The program code associated with the request.

userIdentifierstring required

The unique identifier of the user to whom the attachment will be added. Must be a valid GUID.

Headers

X-GD-RequestIdstring required

The unique request identifier for idempotency and tracking. Must be provided in the X-GD-RequestId header.

Request body

attachmentType'MLADocument' | 'SCRADocument'

The type of attachment being uploaded (e.g., MLA document, SCRA document).

attachmentstring byte nullable

The binary file data of the attachment (e.g., PDF, image) to be uploaded.

attachmentExtensionstring nullable

The file extension of the attachment (e.g., "pdf", "jpg", "png").

effectiveDatestring date-time nullable

The date when the attachment becomes effective, if applicable.

expirationDatestring date-time nullable

The date when the attachment expires, if applicable.

accountIdentifierstring nullable

The unique identifier of the account associated with the consumer profile.

Response

OK