Request Process

Method to make a request for a process by means of the identification number.

Function name

@POST//RequestProcess

Parameters ## Parameter

Parameter	Type	Required	Description
guidConv	String	SI	Unique Agreement Identifier
advisor	String	YES	Name associated with the advisor
headquarters	String	SI	Numerical code associated to the advisor's head office
codigoCliente	String	SI	SI
infCandidate	String	SI	Name associated to the advisor
completed	boolean	SI	Indicator indicating activity in the process
Citizen	Object	SI	Structure of the citizen object
-TypeDoc	String	SI	Document type associated to the process
-numDoc	String	SI	Document number associated to the process
-email	String	SI	Email associated to the process -cellular
cellular	String	SI	Cellular of document associated to the process -state
status	int	SI	1 for save citizen, 2 for validatebiometrics

Response Obtained

With this method the following data is obtained from the consultant:

Code 200

Object	Type	Description
processAgreementGuid	String	String
guidCiu	String	Citizen Identifier
processState	int	Int
responseTransaction	Object	Structure of the responseTransaction object
-Successful	Boolean	Flag that indicates if the query was successful.
-errorTransaction	Array/String	Array indicating what kind of errors can be obtained
--code	String	Numeric code associated with the error
--description	String	Description associated with the error

Cancel Process

Method to cancel a process.

Name of the function

@POST/CancelProcess

Parameters ## Parameter

Parameter	Type	Required	Description
guidConv	String	SI	Unique identifier of each advisor
advisor	String	SI	Name associated with the advisor
String	SI	SI	Reason why you want to cancel the process

Response Obtained

With this method the cancellation response is obtained:

Code | 200

Object	Type	Description
responseTransaction	Object	Structure of the object responseTransaction
-Successful	Boolean	Flag indicating whether the cancellation was successful
-errorTransaction	Array/String	Array indicating what kind of errors can be obtained
--code	String	Numeric code associated with the error
--description	String	Description associated with the error

Query Process Status

Method to query the status of the processes.

Function name ## Function name

@POST//QueryProcessStatus

Parameters ## Parameter

Parameter	Type	Required	Description
guidConv	String	SI	Unique agreement identifier
advisor	String	SI	Name associated to the advisor
InitialDate	String	SI	Initial date associated with the process
dateFinal	String	SI	Final date associated to the process

Response Obtained

With this method the following data is obtained from the advisor:

Code | 200

Object	Type	Description
states	Array/String	Structure of the data objectProcess
values	Array/Object	Structure of the values object
-date	String	Date on which the process is located
-dataY	Array/Integer	Array containing the number of states of a process
responseTransaction	Object	Structure of the responseTransaction object
-Successful	Boolean	Flag indicating if the query was successful
-errorTransaction	Array/String	Array indicating what kind of errors can be obtained
--code	String	Numeric code associated with the error
--description	String	Description associated with the error