sgrGerarPessoaFisicaV4

It registers individuals when there is a need to send a profile for research.

PARAMETERS:

Field	Type	Req.	Description
keyaccess	string	Yes	Key returned by the sgrLogin method.
cdpas	integer	Yes	PAS code, returned by the sgrListaPASUsuario method
cdclient	integer	Yes	Client code, returned by the sgrListCompaniesPASUser method.
cdpaisorigem	integer	Yes	Employee's nationality code, returned by the sgrListPais method.
numDocOrgExp	integer	Yes	ID card issuing country. Code returned by the sgrListaOrgaoEmissorRG method, only when the country of origin is Brazil (cdpaisorigem=1), inform -1 in other cases.
numDocUF	integer	Yes	Code of the state where the CNH was issued. This code is returned by the sgrListaUF method.
strDocVinculo	string	Yes	Professional profile link code. This code is returned by the sgrListaTiposVinculoPF.
dtDocEmissao	string	Yes	Document issue date (CPF). Format 'YYYY-MM-DD'.
dtDocMOOP	string	No	MOPP expiration date. Format 'YYYY-MM-DD'. Enter '1900-01-01' when it doesn't exist.
dtDocEmissaoCNH	string	No*	CNH issue date. Enter '1900-01-01' when it does not exist. * Mandatory when the professional is a driver.
dtDocVencCNH	string	No*	CNH expiration date. Enter '1900-01-01' when it does not exist. * Required when the professional is a driver.
strDocCPF	string	Yes	Document number (CPF). Enter only the digits.
strDocRG	string	Yes	ID number. Enter only the digits.
strDocNrCNH	string	No*	CNH number. Send “” (blank) when it doesn't exist. * Required when the professional is a driver.
strDocCategoria	string	No*	Driver's license category. Send “” (blank) when it doesn't exist. * Mandatory when the professional is a driver.
strDocNrRegistro	string	No*	Driver's license registration number. Send “” (blank) when it doesn't exist. * Required when the professional is a driver.
numDpProfissao	integer	Yes	Profession code. Returned by the sgrListProfession method.
numDpEstCivil	integer	Yes	Marital status code, returned by the sgrListaEstadoCivil method.
numDpSitResidencia	integer	Yes	Residential status code. This code is returned by the sgrListaTiposSituacaoResidencia method.
numDpNrYear	integer	Yes	Length of residence (years).
numDpNrMonths	integer	Yes	Length of residence (months).
numDpNationality	integer	Yes	Nationality code. This code is returned by the sgrListNationality method.
numDpNaturality	integer	Yes	Naturality code. This code is returned by the sgrListCities method.
dtDpBirth	string	Yes	Professional's date of birth. Format 'YYYY-MM-DD'.
strDpName	string	Yes	Professional's name [50 characters]
strDpName	string	No	Professional's surname. Send “” (blank) when it doesn't exist.
strDpFather	string	Yes	Father's name. Send “Not informed” when it doesn't exist.
strDpMae	string	Yes	Mother's name.
strDpSpouse	string	No	Spouse's name. Send “” (blank) when it doesn't exist.
strDpSex	string	Yes	Sex of professional. Can be 'F' or 'M'.
numEndCity	integer	Yes	City of residence code. This code is returned by the sgrListCities method.
strEndStreet	string	Yes	Street of residence.
strEndBairro	string	Yes	Neighborhood of residence.
strEndNumber	string	Yes	Residence number.
strEndComplement	string	No	Address complement. Send “” (blank) when it doesn't exist.
strEndCEP	string	No	Address zip code. Send “” (blank) when it doesn't exist.
strEndDD1	string	Yes	DDD of phone 1.
strEndPhone1	string	Yes	Phone number 1.
strEndDD2	string	No*	DDD of phone 2. * Mandatory if strEndPhone2 is filled
strEndPhone2	string	No	Phone number 2. Send “” (blank) when it doesn't exist.
strEndDDDFax	string	No*	Fax DDD. * Mandatory if strEndFax is filled in.
strEndFax	string	No	Fax number. Send “” (blank) when it doesn't exist.
strEndEmail	string	No	E-mail address. Send “” (blank) when it doesn't exist.
strPFType	string	No	Type of Person. Always send “” (blank).
nrMOPP	string	No	Professional's MOPP number. Send “” (blank) when it doesn't exist.
nrMatriculaCliente	string	No	Enrollment number (employee) at the client [30 characters]. Send “” (blank) when it doesn't exist.
cdEntidadeMOPP	integer	No	MOPP registration entity code. This code is returned by the sgrListMOPPEntities method. Send -1 when no MOPP exists.
dtContratacaoCliente	string	No	Date the professional was hired. Format 'YYYY-MM-DD'. Send “” (blank) when it doesn't exist.
dtVctoAso	string	No	ASO expiration date. Format 'YYYY-MM-DD'. Send “” (blank) when it doesn't exist.
dtVctoRec	string	No	Recycling expiration date. Format 'YYYY-MM-DD'. Send “” (blank) when it doesn't exist.
dtVctoPsi	string	No	Psychotechnic expiration date. Format 'YYYY-MM-DD'. Send “” (blank) when it doesn't exist.
References	List	Yes	List containing the professional's Personal References, of type sgrRefPersonal. The minimum number of personal references required varies according to the client's settings. If you have any doubts about this setting, contact your account manager.
strNrRadio	String	No	Radio number for contacting the driver.

Observation: To make it easier to understand the secondary methods that must be called to return the codes required in the parameters listed above, the following is an analogy between the secondary methods and the registration screen in Clipas NET. The Web Service and Clipas NET do not necessarily have to contain the same fields. In blue, the names of the parameters have been written. In red are the secondary methods.

Figure 1: Complete cadastre of PF no Clipas NET, aba Documents.

Figure 2: Complete PF registration screen in Clipas NET, Personal Ref tab.

Figure 3: Complete PF registration screen in Clipas NET, Personal data tab

Figure 4: Complete FP registration screen in Clipas NET, Address tab.

RETURN METHOD:

ReturnDataset: If the parameters are correctly entered, the ReturnDataset property will be displayed:

Field	Type	Description
CDPFJ	integer	Code of the professional profile registered in the execution of the method

ReturnDescription: If there is an error in the execution of the method, the object's property will display:

Error	Description
Could not register professional profile	In this case, the Web Service must return the dataset with the errors that made registration impossible.

If you need to provide more personal references, you can use the sgrAdicionaRefPessoais