Skip to main content

Audience

Audience APIs enable financial institutions to manage audience user lists used for customer campaigns and targeting. It supports creating and retrieving user list metadata for files uploaded via SFTP, tracking processing status, user counts, and error reports, allowing institutions to monitor and manage campaign audience data securely and efficiently.

End-user benefits​

  • Tie each SFTP-delivered user-list file to metadata (userlistName, userlistOperation, description) so processing aligns with the intended list and operation.
  • See processing state at a glance via viewName=fileStatus (counts, job message) without re-reading the source file.
  • Investigate problems using viewName=fileErrorReport when the service exposes an error-report view for a file.

Integration capabilities​

  • Create and retrieve user list metadata for files uploaded via SFTP
  • Track processing status and user counts for uploaded files
  • Retrieve error reports for failed file uploads

Required headers​

HeaderDescription
AuthorizationBearer OAuth 2.0 access token
transactionIdUUID for request tracing

Error codes​

HTTP Status CodeMessage
400Bad Request — invalid or missing parameters, headers, or body
500Internal Server Error — unexpected server failure

Endpoints​

Create User List Metadata

Metadata for the file uploaded through SFTP

Get User List Details

Gets user list details corresponding to the viewName, userlistFileName specified