Placeholder

Interfaces - Details - Collect

This method is used to query the status of an Authenticate or a Sign order. The return value is only progress status until the end user is finished and the order is complete. Once the order is complete the return values are also the resulting PKCS#7 signature, the OCSP response when validating the end users certificate and some information about the end user.

Input

The input parameter to Collect is the following:

Parameter

Description

Required

orderRef

An identifier that uniquely identifies an order. Returned by Authenticate or Sign method.

Yes

Output

Output parameters from Collect are the following:

Parameter

Description

Required

progressStatus

An enumeration describing at what stage the processing of the Authenticate or Sign order, see below

Yes

signature

A validated or not validated Signature encoded as base 64. The format is according to PKCS#7 Attached. This is only present if progressStatus is COMPLETE.

No

userInfo

An element of type UserInfoType with information about the end user, see below. This is only present if progressStatus is COMPLETE.

No

ocspResponse

Status of the certificate when the signature was validated, OCSP response encoded as base 64, see below. This is only present if progressStatus is COMPLETE.

No

OCSP Response

The OCSP response is signed. The OSCP response can depend on responder

UserInfo Type

UserInfoType holds information about the end user that is returned to the SP.

Parameter

Description

Required

name

Name of the end user.

Yes

personalNumber

The Personal Number of the end user.

Yes

notBefore

Validity time

Yes

notAfter

Validity time

Yes

givenName

Given name of the end user.

Yes

surname

Surname of the end user.

Yes

DeviceInfo Type

DeviceInfo Type holds information about the end users device that is returned to the SP.

Parameter

Description

Required

name

?

Yes

version

OS and version

Yes

address

IP-adress

Yes

Status

The progressStatus element in the Collect response message is of the type ProgressStatusType that is an enumeration with the following elements:

Parameter

Description

COMPLETE

The signature is complete and is included in the response.

USER_SIGN

The request has been delivered to the End User (mobile client).

OUSTANDING_TRANSACTION

The request has not yet been sent to the End User.

Dela denna artikel

Relaterat