POST/counterparty/{userId}/create

Create Counterparty (Individual)

Creates an individual counterparty for a user. The counterparty represents a recipient for payments and transfers.

Path variables

Field	Type	Required	Possible values	Description
`userId`	string	Required	—	Unique user ID for whom the counterparty is being created & respective user must be active

Headers

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

Field	Type	Required	Possible values	Description
`Group`	string	Required	Individual	Counterparty group type.
`CustomValues.RegistrationFirstName`	string	Required	—	First name of the individual counterparty.
`CustomValues.RegistrationLastName`	string	Required	—	Last name of the individual counterparty.
`Addresses`	array	Required	[{ Name, Street, BuildingNumber, City, Region, Zip, Country }]	Array of address objects (Name, Street, BuildingNumber, City, Region, Zip, Country).
`Email`	string	Optional	—	Email address of the counterparty.
`CustomValues.RegistrationMiddleName`	string	Optional	—	Middle name of the individual counterparty.
`CustomValues.Relationship`	string	Optional	SELF \| NIECE \| SISTER_IN_LAW \| SON \| AUNT \| BROTHER \| FRIEND \| MOTHER_IN_LAW \| OTHER \| BROTHER_IN_LAW \| FATHER \| FATHER_IN_LAW \| NEPHEW \| SISTER \| UNCLE \| WIFE \| COUSIN \| DAUGHTER \| GRAND_FATHER \| GRAND_MOTHER \| HUSBAND \| MOTHER	Relationship to the counterparty.
`CustomValues.RelationshipOther`	string	Optional	—	Required only when Relationship is OTHER. Free-text description of the relationship.
`MobilePhones`	array	Optional	[{ Name: MOBILE \| LAND_LINE, Number }]	Array of phone objects with Name (MOBILE \| LAND_LINE) and Number.must be a valid phone number and required at least one phone number.

Example request

{
  "Group": "Individual",
  "Email": "james.michael.doe@example.com",
  "CustomValues": {
    "RegistrationFirstName": "James",
    "RegistrationMiddleName": "Michael",
    "RegistrationLastName": "Doe",
    "DateOfBirth": "1990-05-15",
    "Relationship": "FRIEND"
  },
  "Addresses": [
    {
      "Name": "Home Address",
      "Street": "123 Main Street",
      "BuildingNumber": "Apt 4B",
      "City": "New York",
      "Region": "NY",
      "Zip": "10001",
      "Country": "US"
    }
  ],
  "MobilePhones": [
    {
      "Name": "MOBILE",
      "Number": "+12125551234"
    },
    {
      "Name": "LAND_LINE",
      "Number": "+12125555678"
    }
  ]
}

{
  "Group": "Individual",
  "Email": "james.michael.doe@example.com",
  "CustomValues": {
    "RegistrationFirstName": "James",
    "RegistrationMiddleName": "Michael",
    "RegistrationLastName": "Doe",
    "DateOfBirth": "1990-05-15",
    "Relationship": "FRIEND"
  },
  "Addresses": [
    {
      "Name": "Home Address",
      "Street": "123 Main Street",
      "BuildingNumber": "Apt 4B",
      "City": "New York",
      "Region": "NY",
      "Zip": "10001",
      "Country": "US"
    }
  ],
  "MobilePhones": [
    {
      "Name": "MOBILE",
      "Number": "+12125551234"
    },
    {
      "Name": "LAND_LINE",
      "Number": "+12125555678"
    }
  ]
}

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	ID of the newly created individual counterparty.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": "3678206478455844829"
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": "3678206478455844829"
}

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.