api:simusercreation

This is an old revision of the document!


Authentication

This endpoint has authentication via Bearer token, to generate this token you can use the authentication endpoint, this is the information you need to use to request an authentication token:

Url: https://api-sim.t4login.com/login

Method: POST

Body:

{
  "UserName": "<Sim subscriber username>",
  "Password": "<Sim subscriber password>",
  "Firm": "<Firm to subscribe>",
  "AppName":"<Sim subscription application name>",
  "AppLicense":"<Sim subscription application license>"
}

The login information will be provided to you by CTS

This endpoint will return an object in the following format:

{
 "token":"string",
 "expires":int
}

The value of the property Token is your authentication token, and the value on the property expires is the timestamp when the token is no longer valid.

API Usage

This API endpoint receives a JSON body in the following format:

{
  "UserName": string,
  "Password": string,
  "EmailAddress": string,
  "FirstName": string,
  "LastName": string,
  "PhoneNumber": string,
  "Address": {
	"Street": string,
	"City": string,
	"County": string,
	"State": string,
	"Country": string,
	"ZIPPostCode": string
  },
  "ApplicationType":int,
  "EULA": {
	"CollectedBy": string,
	"Signatures": [
	  {
		"DocumentName": string,
		"Signed": DateTime
	  }
	]
  }
}

This are the valid values for each property:

  • UserName: Required, Maximun of 10 characters.
  • Password: Required, Minimun 8 Characters long, should have at least one upercase letter, one lower case letter, one number, one symbol and should not contain 3 or more characters consecutive characters from the username.
  • EmailAddress: Required, A valid Email address, needs to be unique in the system, temporary email addresses are not allowed.
  • FirsName: Required, Numbers are not allowed
  • LastName: Required, Numbers are not allowed
  • PhoneNumber: Required, Should be 10 digits long
  • Address: Required, Json object as described in the json structure before.
  • Street: Required
  • City: Optional in the USA, will be taken from the zipcode
  • County: Optional in the USA, will be taken from the zipcode
  • State: Required, 2 Characters long, use ISO codes (https://en.wikipedia.org/wiki/ISO_3166-2:US
  • Country: Required, 2 Characters long, use A-2 ISO codes (https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
  • ZipPostCode Required
  • ApplicationType: Required, Manual = 0, ATS = 1, Professional = 2, NonProfessional = 3, Desk = 4, Wallboard = 5, ATSDisplay = 7, FinancialProfessional = 8. You will probably use 3.
  • Signatures: Json list as described in the Json structure before, all documents need to have a related signature.
  • CollectedBy: Required
  • DocumentName: Required, The Document names are: LegalEULA, LegalPP, LegalMDSA, LegalUSA, LegalNPSCF. More information about these documents will be provided in the next section.
  • Signed: Required
  • api/simusercreation.1721683843.txt.gz
  • Last modified: 2024/07/22 21:30
  • by daniel