STstreampay
Consumers

Get Consumer

Changed on

Retrieve detailed information about a specific consumer by their ID.

get/api/v2/consumers/{consumer_id}

Request

  • Base URL
    https://stream-app-service.streampay.sa
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Path parameters

consumer_idstring uuid required

Unique identifier (UUID) of the consumer

Response

Successful Response

idstring uuid4

Unique identifier (UUID) of the organization consumer

namestring

Name of the consumer

phone_numberstring phone nullable

Phone number of the consumer

emailstring email nullable

Email address of the consumer

external_idstring nullable

External identifier for the consumer

ibanstring nullable

IBAN (International Bank Account Number) of the consumer

is_deletedboolean

Whether the consumer has been deleted

aliasstring nullable

Alias of the consumer

created_atstring date-time

Date and time when the consumer was created

commentstring nullable

Additional comments or notes about the consumer

communication_methodsConsumerCommunicationMethod[]

Preferred communication methods for the consumer

preferred_language'AR' | 'EN'
consumer_type'INDIVIDUAL' | 'BUSINESS'
vat_numberstring nullable

VAT number (optional for business type)

commercial_registrationstring nullable

Commercial registration number (optional for business type)

external_metadataExternalMetadataStorage
fieldsobject

Catalog field values for this consumer

Changes

  • bb23366f1a76Revision changes
    • info

      added the optional property to the response with the status

  • dfac786362d9Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      the response optional property / became read-only for the status