REGISTO

Método ListCountries

Permite obter uma lista de países.

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUserName Utilizador de acesso à API String
APIPassword Password de acesso à API String

Parâmetro Saída:

Parâmetro Descrição Tipo
OperationResultCode Código Resposta Int
OperationResultMessage Mensagem Resposta String
Countries Lista de Países CountryItem

CountryItem :

Parâmetro Descrição Tipo
Code Código do País String
Name Nome do País String

Códigos Reposta:

Código Descrição
0 Sucesso
1 Dados de acesso à API inválidos
2 Dados de acesso à API inválidos

Exemplo:

 


Método ListActivityTypes
Permite obter uma lista de sectores de actividades

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUserName Utilizador de acesso à API String
APIPassword Password de acesso à API String

Parâmetro Saída:

Parâmetro Descrição Tipo
OperationResultCode Código Resposta Int
OperationResultMessage Mensagem Resposta String
ActivitieTypes Lista de Sectores de Actividade ActivityTypeItem

ActivityTypeItem:

Parâmetro Descrição Tipo
Id Identificador Sector de Actividade Int
Name Nome do Sector de Actividade String

Códigos Reposta:

Código Descrição
0 Sucesso
1 Dados de acesso à API inválidos

 


Método ListJobs
Permite obter uma lista de Profissões

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUserName Utilizador de acesso à API String
APIPassword Password de acesso à API String

Parâmetro Saída:

Parâmetro Descrição Tipo
OperationResultCode Código Resposta Int
OperationResultMessage Mensagem Resposta String
Jobs Lista de Profissões JobItem

JobItem:

Parâmetro Descrição Tipo
Id Identificador da Profissão Int
Name Nome da Profissão String

Códigos Reposta:

Código Descrição
0 Sucesso
1 Dados de acesso à API inválidos

 


Método ListIdentificationDocumentTypes
Permite obter uma Lista de Tipos de Documento de Identificação

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUserName Utilizador de acesso à API String
APIPassword Password de acesso à API String

Parâmetro Saída:

Parâmetro Descrição Tipo
OperationResultCode Código Resposta Int
OperationResultMessage Mensagem Resposta String
IdentificationDocumentTypes Lista de Tipos de Documentos de Identificação IdentificationDocumentTypeItem

IdentificationDocumentTypeItem:

Parâmetro Descrição Tipo
Id Identificador do Tipo de Documento de Identificação Int
Name Nome da Tipo de Documento de Identificação String

Códigos Reposta:

Código Descrição
0 Sucesso
1 Dados de acesso à API inválidos

 


Método ListNIFCountry
Permite Obter uma lista de países que podem estar associados a um NIF.

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUserName Utilizador de acesso à API String
APIPassword Password de acesso à API String

Parâmetro Saída:

Parâmetro Descrição Tipo
OperationResultCode Código Resposta Int
OperationResultMessage Mensagem Resposta String
Countries Lista de Países associados a um NIF CountryNIFItem

CountryNIFItem :

Parâmetro Descrição Tipo
Code Código do País String
Name Nome do País String

Códigos Reposta:

Código Descrição
0 Sucesso
1 Dados de acesso à API inválidos

 


Método Registo Particular Simples
Permite fazer um registo simples de um utilizador particular.

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUserName Utilizador de acesso à API String
APIPassword Password de acesso à API String
Email Email do utilizador String
Password Password do utilizador String
PIN PIN do utilizador String
FirstName Primeiro Nome String
LastName Último Nome String
Country Code Código País String
Address Morada String
PostalCode Código Postal String
City Cidade String
CountryNIFCode Código do País associado ao NIF String
NIF NIF do utilizador String
PhoneNumberPrefix Prefixo do Nº Telemóvel String
PhoneNumber Nº Telemóvel String

Parâmetro Saída:

Parâmetro Descrição Tipo
OperationResultCode Código Resposta Int
OperationResultMessage Mensagem Resposta String

Códigos Reposta:

Código Descrição
0 Sucesso
1 Dados de acesso à API inválidos

 

Método Registo Empresa Simples

Permite fazer um registo simples de uma empresa.

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUserName Utilizador de acesso à API String
APIPassword Password de acesso à API String
Email Email do utilizador String
Password Password do utilizador String
PIN PIN do utilizador String
CompanyName Nome Empresa String
ComercialName Nome Comercial da Empresa String
Country Code Código País String
Address Morada String
PostalCode Código Postal String
City Cidade String
CountryNIFCode Código do País associado ao NIF String
NIF NIF do utilizador String
PhoneNumberPrefix Prefixo do Nº Telemóvel String
PhoneNumber Nº Telemóvel String

Parâmetro Saída:

Parâmetro Descrição Tipo
OperationResultCode Código Resposta Int
OperationResultMessage Mensagem Resposta String

Códigos Reposta:

Código Descrição
0 Sucesso
1 Dados de acesso à API inválidos

 

Método Registo Particular Completo
Permite fazer um registo completo de um utilizador particular.

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUserName Utilizador de acesso à API String
APIPassword Password de acesso à API String
Email Email do utilizador String
Password Password do utilizador String
PIN PIN do utilizador String
FirstName Primeiro Nome String
LastName Último Nome String
Country Code Código País String
Address Morada String
PostalCode Código Postal String
City Cidade String
CountryNIFCode Código do País associado ao NIF String
NIF NIF do utilizador String
PhoneNumberPrefix Prefixo do Nº Telemóvel String
PhoneNumber Nº Telemóvel String
DocType Tipo Documento identificação String
DocNumber Nº Documento identificação String
DocValidationDate Data Validade Documento Identificação.Formato aaaa-mm-dd String
FirstNationality Primeira Nacionalidade String
SecondNationality Segunda Nacionalidade String
Naturalness Naturalidade String
Job Profissão String
Employer Empregador String
PoliticJobs Indicação se já exerceu cargos políticos. Boolean
PoliticJobsObservations Observações sobre os cargos políticos Campo Obrigatório, caso o utilizador já tenha exercido cargos políticos String
DocFileBytes Ficheiro de anexo – Comprovativo de documento de identificação. byte[]
DocFileName Nome do Ficheiro de anexo – Comprovativo de documento de identificação. String
AddressFiscalFileBytes Ficheiro de anexo – Comprovativo Morada Fiscal. byte[]
AddressFiscalFileName Nome do Ficheiro de anexo – Comprovativo Morada Fiscal. String

Parâmetro Saída:

Parâmetro Descrição Tipo
OperationResultCode Código Resposta Int
OperationResultMessage Mensagem Resposta String

Códigos Reposta:

Código Descrição
0 Sucesso
1 Dados de acesso à API inválidos

Método Registo Empresa Completo
Permite fazer um registo completo de uma empresa.

Parâmetro Entrada:

Parâmetro Descrição Tipo
APIUserName Utilizador de acesso à API String
APIPassword Password de acesso à API String
Email Email do utilizador String
Password Password do utilizador String
PIN PIN do utilizador String
CompanyName Nome Empresa String
ComercialName Nome Comercial da Empresa String
Country Code Código País String
Address Morada String
PostalCode Código Postal String
City Cidade String
CountryNIFCode Código do País associado ao NIF String
NIF NIF do utilizador String
PhoneNumberPrefix Prefixo do Nº Telemóvel String
PhoneNumber Nº Telemóvel String
PhoneNumber Nº Telemóvel String
WorkAddress Morada Empresa String
WorkCity Cidade Empresa String
WorkPostalCode Código Postal Empresa String
WorkCountryCode País Empresa String
CCP Certidão Permanente String
CAE CAE String
ActivityType Sector de Actividade String

Parâmetro Saída:

Parâmetro Descrição Tipo
OperationResultCode Código Resposta Int
OperationResultMessage Mensagem Resposta String