Redirect user

Data submission

Submit user data to SEEK Pass using the correct endpoint based on credential type. For example, for the Education credential type the endpoint to call is: /api/partner/v1/add/education.json.

Environments

The staging and production environment endpoints are provided below:

• Staging: https://app.seekpass-staging.com
• Production: https://app.seekpass.co

Sample request

Copy
export CREDENTIAL_TYPE=education

export PAYLOAD='{
  "id": "seek-pass-test-a9a4839f-53d9-4064-8b0b-1348113a33f8",
  "document_type": "open_cert",
  "credential_type": "education",
  "data": {
    "credential": {
      "full_name": "John Smith",
      "education_provider": "University of Melbourne",
      "course_name": "Bachelor of Commerce",
      "conferral_year": "2024",
      "has_majors": true,
      "majors": ["Finance"],
      "with_honours": true
    },
    "document": "<OPEN_CERTS>"
  }
}'

curl -L $SEEK_PASS_URL/api/partner/v1/add/$CREDENTIAL_TYPE.json \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $ACCESS_TOKEN" \
--data "$PAYLOAD"

Response codes:

{
    "redirect_uri": "https://app.seekpass-staging.com/partner/add/education#clientId=730845ab-0a0d-4f4d-9c98-d871755d3ce9&documentType=open_cert&content=d8a8eb57-c64f-4fc1-b362-b8df28fbf0a3"
}

Behaviour

• If the same id is used within 48 hours, the same redirect_uri will be returned.
• After 48 hours, the old data is deleted. A new POST request with the same id will save the data with a different SEEK Pass ID and return a new redirect_uri.
• Once the user clicks the link and logs into the system, the data is associated only with them.
• Even if the user has not accepted consent, the data is associated, and the redirect_uri will prompt them to accept consent.
• Once consent is accepted, subsequent requests will return the same URL to view the credential submission.
• In line with our data protection policies, if a user goes through the Add to SEEK Pass flow, but does not download and sign into the mobile application within 48 hrs of completing the flow, the user's documents will be securely deleted.

Redirect to SEEK Pass

The redirect_uri obtained in the previous step must be used to redirect users to the SEEK Pass application.

URL format

The redirect URL is generated with this format:

• Path: /partner/add/[CREDENTIAL TYPE]
  • Examples:
    • For Education: /partner/add/education
    • For English proficiency: /partner/add/englishProficiency
    • For Microcredential: /partner/add/microcredential
    • For Batch: /partner/add/batch
• Host:
  • Production: https://app.seekpass.co
  • Staging: https://app.seekpass-staging.com
• Hash: the parameters below, encoded as URL query parameters
  • clientId: The partner's OAuth client ID
  • documentType: The expected document type
  • content: The SEEK Pass request ID

Batch API

The Batch API allows you to submit multiple credentials in a single API request. This endpoint is able to streamline the user experience of adding multiple credentials at once. This can be used to handle:

1. Multiple of a single type of credential (e.g. 2x Education Qualifications)
2. Multiple of multiple types of credentials (e.g. 1x Digital Identity, 2x Education Qualifications and 5x Learning and Development Credentials)

Copy
export PAYLOAD='{
  ... your batch payload here ...
}'

curl -L $SEEK_PASS_URL/api/partner/v1/add/batch.json \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $ACCESS_TOKEN" \
--data "$PAYLOAD"

Response codes:

{
    "redirect_uri": "https://app.seekpass-staging.com/partner/add/batch#clientId=730845ab-0a0d-4f4d-9c98-d871755d3ce9&content=b4ce8d4e-f293-4492-9d7a-4210bdbe099e"
}