Create a Consumer Profile

post

https://{host}/consumer/v2/profiles

The Create a consumer profile api determines the information required to create a new consumer profile.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create Consumer Profile.

targetAudience

string

Defaults to AGENT_FACING

Tailors MoneyGram’s error messages and field metadata to an in-store, digital or crypto customer. (Enumerated value)

agentPartnerId

string

Defaults to 30150519

Unique identifier for the agent or partner

userLanguage

string

required

Defaults to en-US

Language used by the user/operator

consumer

object

additionalDetails

array of objects

length ≥ 0

Dynamic field key/values

additionalDetails

Headers

X-MG-ClientRequestId

string

Defaults to 4c79b06f-a2af-4859-82c8-28cbb0bf361b

Client Request Id that can be passed by the client application. Client request Id must be unique within a single session for unique requests. This attribute can be used for ensuring idempotent request processing for some APIs. MoneyGram recommends using a UUID for the value of this field.

X-MG-ConsumerIPAddress

string

IP Address of the system initiating the session.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK. Returns Consumer Profile ID, if available.

400Bad request. Returns error details.

401Unauthorized. Returns error details.

403Forbidden. Returns error details.

500Internal server error. Returns error details.