POST api/v1/client/register

Register a new client - uses a two-factor authentication.

Request Information

URI Parameters

None.

Body Parameters

SetRegistrationBindingModel
NameDescriptionTypeAdditional information
EmailAddress

string

Required

Data type: EmailAddress

String length: inclusive between 6 and 256

FirstName

string

Required

Data type: Text

LastName

string

Required

Data type: Text

Company

string

Required

Data type: Text

ApplicationName

string

Required

Data type: Text

CountryCode

string

Required

Data type: Text

String length: inclusive between 3 and 3

Request Formats

application/json, text/json

Sample:
{
  "EmailAddress": "larry@newmedia.com",
  "FirstName": "Larry",
  "LastName": "Raddler",
  "Company": "New Media",
  "ApplicationName": "NewMedia Payments",
  "CountryCode": "USA"
}

application/xml, text/xml

Sample:
<SetRegistrationBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <ApplicationName>NewMedia Payments</ApplicationName>
  <Company>New Media</Company>
  <CountryCode>USA</CountryCode>
  <EmailAddress>larry@newmedia.com</EmailAddress>
  <FirstName>Larry</FirstName>
  <LastName>Raddler</LastName>
</SetRegistrationBindingModel>

Response Information

Resource Description

Values are returned as a collection of strings.

RegistrationOutgoingModel
NameDescriptionTypeAdditional information
Message

MessageModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": {
    "Code": "(2 digit code reflecting result of request - 00 is good)",
    "Description": "(Message response in text depending upon request/result of request)"
  }
}

application/xml, text/xml

Sample:
<RegistrationOutgoingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Payments.Api.Models">
  <Message>
    <Code>(2 digit code reflecting result of request - 00 is good)</Code>
    <Description>(Message response in text depending upon request/result of request)</Description>
  </Message>
</RegistrationOutgoingModel>