POST api/OnBoarding/Migrations

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
GrantorTaxId	RFC	string	Required Matching regular expression pattern: ^[A-Z&Ñ]{3,4}[0-9]{2}(0[1-9]\|1[012])(0[1-9]\|[12][0-9]\|3[01])[A-Z0-9]{2}[0-9A]$ Max length: 13 Min length: 12
ShortName	Nombre Comercial	string	Required Max length: 150
BusinessName	Razón Social	string	Max length: 254 Min length: 2
Name1	Primer nombre	string	Max length: 30
Name2	Segundo nombre	string	Max length: 30
Surname1	Primer apellido	string	Max length: 25
Surname2	Segundo apellido	string	Max length: 25
Email	Identificador del usuario	string	Required Data type: EmailAddress Matching regular expression pattern: ^((?:[\w-]+\.)\w[\w-]{0,63})@((?:[\w-]+\.)\w[\w-]{0,98})\.([a-zA-Z]{2,15}(?:\.[a-zA-Z]{2})?)$
PrefixPhone	Prefijo del telofono.	string	Max length: 4
Phone	Teléfono, pude especificar solo el Teléfono Celular (10 dígitos)	string	Required
PrefixCellphone	Prefijo del celular.	string	Max length: 4
CellPhone	Teléfono Celular, puede especificar solo el Télefono fijo (10 dígitos)	string	Required
BankCode	Banco para la cuenta concentradora	string	Required
PackageCode	Código del paquete que se desea adquirir	string	Required
Country	País	string	None.
State	Estado	string	None.
Municipality	Municipio	string	None.
District	Colonia	string	Max length: 150
Street	Calle	string	Max length: 80
ExternalNumber	Número Exterior	string	Max length: 40
InternalNumber	Número Interior	string	Max length: 40
ZipCode	Código Postal	string	Matching regular expression pattern: ^[0-9]*$
Password	Contraseña que se asignará al userio de la empresa. Nota: Esta contraseña será ignorada cuando el proceso de autenticación sea SSO ó ya se encuentre registrado el usuario en el OAuth de la plataforma	string	None.
ExternalUserId	Identificador del usuario en sistemas externos a la plataforma usado para SSO	string	None.
Functionary	Representante legal, Si es persona Moral es requerido	FunctionaryModelApi	None.
SendEmail	Enviar correo electrónico a la empresa que se registra	boolean	None.
SendSignNotificationEmail	Indica si se requeriere enviar un correo para que se firmen los contratos en la afiliación	boolean	None.
DistributorId	Identificador único del distribuidor que lo registra, en caso de no proporcionarse se tomará el usuario autenticado.	globally unique identifier	None.
Ciec	CIEC (Buzón tributario)	string	None.
RequiredBankAccount	Requiere de cuenta concentradora	boolean	None.
TargetCLABE	CLABE (Cuenta operativa)	string	Matching regular expression pattern: ^[0-9]{18}$
LoadType	Tipo de afiliación	OnboardingLoadType	None.
CommunityCode	Identificador de comunidad	Collection of string	None.
PriceListId	Lista de precios externa	string	None.
SigningType	Tipo de firma de contratos	SigningType	None.
FiscalRegime	Codigo de régimen fiscal	string	None.
CapitalRegime	Régimen capital	string	None.

Request Formats

application/json, text/json

Sample:

{
  "GrantorTaxId": "sample string 1",
  "ShortName": "sample string 2",
  "BusinessName": "sample string 3",
  "Name1": "sample string 4",
  "Name2": "sample string 5",
  "Surname1": "sample string 6",
  "Surname2": "sample string 7",
  "Email": "sample string 8",
  "PrefixPhone": "sample string 9",
  "Phone": "sample string 10",
  "PrefixCellphone": "sample string 11",
  "CellPhone": "sample string 12",
  "BankCode": "sample string 13",
  "PackageCode": "sample string 14",
  "Country": "sample string 15",
  "State": "sample string 16",
  "Municipality": "sample string 17",
  "District": "sample string 18",
  "Street": "sample string 19",
  "ExternalNumber": "sample string 20",
  "InternalNumber": "sample string 21",
  "ZipCode": "sample string 22",
  "Password": "sample string 23",
  "ExternalUserId": "sample string 24",
  "Functionary": {
    "FunctionaryTaxId": "sample string 1",
    "FunctionaryName1": "sample string 2",
    "FunctionaryName2": "sample string 3",
    "FunctionarySurName1": "sample string 4",
    "FunctionarySurName2": "sample string 5",
    "FunctionaryEmail": "sample string 6"
  },
  "SendEmail": true,
  "SendSignNotificationEmail": true,
  "DistributorId": "08de22c4-ae68-2c5c-ba1f-9f7acc6821fc",
  "Ciec": "sample string 27",
  "RequiredBankAccount": true,
  "TargetCLABE": "sample string 29",
  "LoadType": 1,
  "CommunityCode": [
    "sample string 1",
    "sample string 2"
  ],
  "PriceListId": "sample string 30",
  "SigningType": 1,
  "FiscalRegime": "sample string 31",
  "CapitalRegime": "sample string 32"
}

application/xml, text/xml

Sample:

<OnBoardingModelApi xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <GrantorTaxId>sample string 1</GrantorTaxId>
  <ShortName>sample string 2</ShortName>
  <BusinessName>sample string 3</BusinessName>
  <Name1>sample string 4</Name1>
  <Name2>sample string 5</Name2>
  <Surname1>sample string 6</Surname1>
  <Surname2>sample string 7</Surname2>
  <Email>sample string 8</Email>
  <PrefixPhone>sample string 9</PrefixPhone>
  <Phone>sample string 10</Phone>
  <PrefixCellphone>sample string 11</PrefixCellphone>
  <Cellphone>sample string 12</Cellphone>
  <BankCode>sample string 13</BankCode>
  <PackageCode>sample string 14</PackageCode>
  <Country>sample string 15</Country>
  <State>sample string 16</State>
  <Municipality>sample string 17</Municipality>
  <District>sample string 18</District>
  <Street>sample string 19</Street>
  <ExternalNumber>sample string 20</ExternalNumber>
  <InternalNumber>sample string 21</InternalNumber>
  <ZipCode>sample string 22</ZipCode>
  <Password>sample string 23</Password>
  <ExternalUserId>sample string 24</ExternalUserId>
  <Functionary>
    <FunctionaryTaxId>sample string 1</FunctionaryTaxId>
    <FunctionaryName1>sample string 2</FunctionaryName1>
    <FunctionaryName2>sample string 3</FunctionaryName2>
    <FunctionarySurName1>sample string 4</FunctionarySurName1>
    <FunctionarySurName2>sample string 5</FunctionarySurName2>
    <FunctionaryEmail>sample string 6</FunctionaryEmail>
  </Functionary>
  <SendEmail>true</SendEmail>
  <SendSignNotificationEmail>true</SendSignNotificationEmail>
  <DistributorId>08de22c4-ae68-2c5c-ba1f-9f7acc6821fc</DistributorId>
  <Ciec>sample string 27</Ciec>
  <RequiredBankAccount>true</RequiredBankAccount>
  <TargetCLABE>sample string 29</TargetCLABE>
  <LoadType>Campaign</LoadType>
  <CommunityTags>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </CommunityTags>
  <PriceListId>sample string 30</PriceListId>
  <SigningType>Acceptance</SigningType>
  <FiscalRegime>sample string 31</FiscalRegime>
  <CapitalRegime>sample string 32</CapitalRegime>
</OnBoardingModelApi>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OnBoardingModelApi'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.