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

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"

We recommend using a globally unique value (e.g. UUID) for id to ensure proper tracking of user requests.

To download files (PDF, JPG, PNG, etc.) linked in the document field, ensure the following requirements are met:

Public accessibility: Files must be accessible without authentication
Domain whitelisting: Your domain must be added to SEEK Pass's VPC firewall allowlist

Please contact our team to request domain whitelisting.

Response codes

201 Created: Successful request

{
    "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"
}

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 Learning and Development: /partner/add/microcredential
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

Note: CURL returns invalid \u0026 instead of &. Please replace \u0026 with & in the redirect URL. Other clients should not have this issue.

Behaviour

ID Reuse within 48 hours: Submitting a request with an existing ID within 48 hours returns the original `redirect_uri`.
ID Reuse after 48 hours: After 48 hours, the original data is permanently deleted. Resubmitting with the same ID creates a new credential request with a distinct SEEK Pass ID and generates a new `redirect_uri`.
User Association: When a user accesses the `redirect_uri` and authenticates, the credential data becomes associated with their account.
Consent Flow: Credential data is associated with the user's account upon authentication, regardless of consent status. If consent has not been granted, the `redirect_uri` will prompt the user to accept.
Post-Consent Behavior: Once consent is granted, subsequent API requests return the same URL, directing users to their submitted credentials.
Data Retention Policy: If a user completes the user flow but does not download and authenticate via the mobile application within 48 hours, all associated documents are securely deleted in accordance with data protection policies.

Once a user clicks the link and logs into the system, the data is associated only with them. If another user attempts to use the same link, they will be redirected to an error page.

Updating existing credentials

To update a credential with a new version of the same credential, partners must submit a new request with the same values for specific fields used in the original submission.

Scenarios where this may be necessary include:

A user updating a credential as the original one is about to expire
A user retaking assessment based credential and has received a new score
A user with an Education Qualification in an ‘awaiting graduation’ has now been conferred

For a newer version of the same credential to replace an existing one, the following fields need to remain the same:

Education: course_name, conferral_year, majors (if applicable), with_honours (if applicable)
English Proficiency: test_name, test_provider
Learning and Development: microcredential_name, issuer_name

This will create a new Add to SEEK Pass request which must be sent to the user, allowing them to update their credential information.

Previous: Expiry & revocation

Next: Check submission status