API Reference

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

post
https://example.com/programs//users//uploadAttachment

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.

Path Params
string
required

The program code associated with the request.

string
required

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

Body Params

The Gd.Bos.DataTransfer.Request.UploadConsumerProfileAttachmentRequest object containing the attachment data and metadata.

string
enum

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

Allowed:
string | null

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

string | null

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

date-time | null

The date when the attachment becomes effective, if applicable.

date-time | null

The date when the attachment expires, if applicable.

string | null

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

Headers
string
required

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago