User

Operations to manage unapproved users for an entity.

Create a new unapproved user

post

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.

Path parameters

entityUidstring · uuidRequired

The Verifone allocated unique id for this site.

Example: 14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9

Body

application/json

The details of a Contact.

contactTypestring · enumRequired

An indicator for the type of contact.

Value	Description
BUSINESS	Generic business contact information, e.g. [e-mail]
DISPUTE_HANDLING	Generic contact information specific to dispute handling, e.g. [e-mail]
OWNER	Individual contact information of the owner of the Entity, e.g. [e-mail]
PERSONAL	Personal contact information of the person representing the Entity, e.g. [e-mail]

Default: BUSINESSPossible values:

emailstring · email · min: 3 · max: 254Optional

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.

Pattern: ^[a-zA-Z0-9!#$%&'*+=?^_`{|}~.-]+@[a-zA-Z0-9-]+[.].+$

businessTitlestring · max: 100Optional

Responses

201

User Created.

application/json

userUidstring · uuidRequired

Unique identifier for the user

Example: 04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden Request.

application/json

404

Not Found Request

application/json

429

Too Many Requests

application/json

500

Internal Error

application/json

503

Service Not Available

application/json

504

Service Timeout

application/json

post/entities/{entityUid}/users

HTTPcURLJavaScriptPython

POST /entities/{entityUid}/users HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 310

{
  "contactType": "BUSINESS",
  "name": {
    "firstName": "text",
    "lastName": "text",
    "prefix": "text",
    "alternateFullName": "text",
    "middleName": "text",
    "suffix": "text"
  },
  "phoneNumbers": [
    {
      "callingCode": "text",
      "value": "text",
      "extension": "text",
      "isPrimary": false,
      "phoneType": "HOME"
    }
  ],
  "email": "[e-mail]",
  "businessTitle": "text"
}

{
  "userUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1"
}

Create a new unapproved user, version 2

post

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.

Path parameters

entityUidstring · uuidRequired

The Verifone allocated unique id for this site.

Example: 14f5ea24-cc4f-11e8-a8d5-f2801f1b9fd9

Body

application/json

The details of a Contact.

or

Responses

201

User Created.

application/json

userUidstring · uuidRequired

Unique identifier for the user

Example: 04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1

400

Bad Request

application/json

401

Unauthorised Request

application/json

403

Forbidden Request.

application/json

404

Not Found Request

application/json

429

Too Many Requests

application/json

500

Internal Error

application/json

503

Service Not Available

application/json

504

Service Timeout

application/json

post/v2/entities/{entityUid}/users

HTTPcURLJavaScriptPython

POST /v2/entities/{entityUid}/users HTTP/1.1
Host: api.verifone.com
Content-Type: application/json
Accept: */*
Content-Length: 339

{
  "customerType": "NewCustomer",
  "contactType": "BUSINESS",
  "name": {
    "firstName": "text",
    "lastName": "text",
    "prefix": "text",
    "alternateFullName": "text",
    "middleName": "text",
    "suffix": "text"
  },
  "phoneNumbers": [
    {
      "callingCode": "text",
      "value": "text",
      "extension": "text",
      "isPrimary": false,
      "phoneType": "HOME"
    }
  ],
  "email": "[e-mail]",
  "businessTitle": "text"
}

{
  "userUid": "04f5ea24-cc4f-11e8-a8d5-f2801f1b9fd1"
}