POST /entities/{entityUid}/users
Create an unapproved merchant user associated to the target customer entity. The target entity needs to have a customer profile in the portfolio service and an entity configured to add unapproved users to in the customer profile.
Servers
- https://emea.gsc.verifone.cloud/oidc/order-service
- https://us.gsc.verifone.cloud/oidc/order-service
- https://nz.gsc.verifone.cloud/oidc/order-service
- https://cst.test-gsc.vfims.com/oidc/order-service
- https://uscst-gb.gsc.vficloud.net/oidc/order-service
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
entityUid |
String | Yes |
The Verifone assigned ID corresponding to the entity. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
phoneNumbers[] |
Array | No |
The phone numbers to be used for the Contact. If you include this property there should be at least one phone number. |
phoneNumbers[].isPrimary |
Boolean | No |
Indicates that the phone is a the primary phone. Mapped to PARTY_PHONE_PRIMARY Default value: false |
phoneNumbers[].callingCode |
String | No |
Country Calling Code. Mapped to PARTY_PHONE.CALLING_CODE or VENUE_PHONE.CALLING_CODE |
phoneNumbers[].phoneType |
String | Yes |
Phone type in PHONE_TYPE_CON. Mapped to PARTY_PHONE.PHONE_TYPE_CON_ID or VENUE_PHONE.PHONE_TYPE_CON_ID Valid values:
Default value: "HOME" |
phoneNumbers[].extension |
String | No |
The internal extension number where applicable or known. |
phoneNumbers[].value |
String | Yes |
The actual phone number less country code and/or extension. |
email |
String | No |
A valid internationalized email address, as defined by RFC 5322, RFC 6530, and other RFCs. Due to RFC 5321, an email address can be up to 254 characters long even though up to 64 characters are allowed before and 255 characters are allowed after the @ sign. This pattern verifies only that the string contains an unquoted @ sign. See https://tools.ietf.org/html/rfc5322#section-3.4.1. |
businessTitle |
String | No |
Business Title. |
contactType |
String | Yes |
An indicator for the type of contact Valid values:
Default value: "BUSINESS" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.