Credentialing requirements

API to get credentialing requirements for the job seeker.

Get Credential requirements

GET https://www.ondemandstaffing.app/api/v1/jobseeker/get_credentials_requirements

This endpoint alllows you to get all the credential/certificates requirements from the job seeker. Note: This API should only be used if the tenant has configured allowing a dedicated tab for credentials. We can find if the tenant has allowed this configuration or not, via tenant api with key: `special_tab_on_onboarding_candidate_for_certificates` is set to `true`.

Query Parameters

Name	Type	Description
tenant	string	The tenant key for which the API is being used.

Headers

Name	Type	Description
Authentication	string	Authentication token to identify the job seeker requesting the data.

200 Credentialing requirements successfully retrieved. Explaination and use case for important fileds: 1. cert_name: indicates the official name of the certificate. 2. required_fields: indicates the fields required for this credential 3. hidden_fields: indicates the fields not to be asked for this credential 4. geography_scoped: indiciates if we need to ask where this credential was issued. Usually mapped to geo_level_one. When set to 'single_select' the user can only select one geo_level_one_option, when set to 'multi_select' the user can select multiple geo_level_one_options. If geography_scoped is set to either single_select or multi_select, an additional field willl be available known as: geo_level_one_options: These are the options that the user can select a value from. 5. key: is required when updating the value of the credential. 6. suggested: could be true or false. If true indicates that we should provide a prompt to the user to provide this credentials. This suggestion is based on the job preferences by the user. 7. suggested_for: If suggested is true, we will provide a list of jobs this credential is required for.

{
    "cert_8": {
        "id": 8,
        "cert_name": "Wolf Platform Certified",
        "description": "Got trained on Wolf platform",
        "required_fields": [
            "certificate_file"
        ],
        "hidden_fields": [
            "credential_url"
        ],
        "validation_criteria": null,
        "additional_fields": null,
        "is_active": true,
        "public_profile_visibility": "hidden",
        "pre_hire_jose_prof_visibility": "hidden",
        "post_hire_jose_prof_visibility": "hidden",
        "geography_scoped": null,
        "key": "cert_8",
        "value": {
            "issue_date": "Dec 18, 1970",
            "certificate_name": "Some certificate for wolf",
            "certificate_file": "https://cdn.filestackcontent.com/8NdmH6dOSEe11xJ6Rpu9",
            "expiry_date": "May 13, 2021",
            "issuing_authority": "Wolf Inc. ",
            "credential_id": "293939393",
            "id": "944e6cb2f91b298551c5b412bf0ec4c1",
            "cert_request_id": "8"
        },
        "suggested": false
    },
    "cert_6": {
        "id": 6,
        "cert_name": "Server Certificates",
        "description": "",
        "required_fields": [
            "certificate_file",
            "credential_url"
        ],
        "hidden_fields": [
            "issuing_authority",
            "certificate_file",
            "credential_id",
            "credential_url",
            "issue_date"
        ],
        "validation_criteria": null,
        "additional_fields": null,
        "is_active": true,
        "public_profile_visibility": "hidden",
        "pre_hire_jose_prof_visibility": "presence",
        "post_hire_jose_prof_visibility": "hidden",
        "geography_scoped": null,
        "key": "cert_6",
        "suggested": true,
        "suggested_for": [
            "Server",
            "Security",
            "Barista",
            "Bartender",
            "Data entry clerk"
        ]
    },
    "cert_5": {
        "id": 5,
        "cert_name": "Bartending Certificate",
        "description": "Provide Bartending certificate from New York or other county. Provide Bartending certificate from New York or other county. Provide Bartending certificate from New York or other county. ",
        "required_fields": [
            "issuing_authority",
            "credential_id"
        ],
        "hidden_fields": [
            "issue_date"
        ],
        "validation_criteria": null,
        "additional_fields": null,
        "is_active": true,
        "public_profile_visibility": "hidden",
        "pre_hire_jose_prof_visibility": "value",
        "post_hire_jose_prof_visibility": "hidden",
        "geography_scoped": "single_select",
        "key": "cert_5",
        "geography_scoped_options": [
            "New York",
            "California",
            "Illinois",
            "Florida",
            "Texas",
            "Pennsylvania",
            "Georgia",
            "District of Columbia",
            "Massachusetts",
            "Arizona",
            "Washington",
            "Michigan",
            "Minnesota",
            "Colorado",
            "Maryland",
            "Nevada",
            "Oregon",
            "Missouri",
            "Ohio",
            "Indiana",
            "North Carolina",
            "Virginia",
            "Wisconsin",
            "Rhode Island",
            "Utah",
            "Tennessee",
            "Louisiana",
            "Kentucky",
            "Oklahoma",
            "Connecticut",
            "Nebraska",
            "Hawaii",
            "New Mexico",
            "Alabama",
            "South Carolina",
            "Kansas",
            "Iowa",
            "Arkansas",
            "Idaho",
            "Puerto Rico",
            "Mississippi",
            "New Jersey",
            "Alaska",
            "New Hampshire",
            "North Dakota",
            "Maine",
            "South Dakota",
            "West Virginia",
            "Montana",
            "Delaware",
            "Vermont",
            "Wyoming"
        ],
        "value": {
            "issue_date": "May 02, 2021",
            "certificate_name": "Bartending Certificate",
            "expiry_date": "May 25, 2022",
            "issuing_authority": "Self issued",
            "credential_id": "23232",
            "id": "a8beab079b910f298a696cfe596c9fa4",
            "cert_request_id": "5",
            "geo_level_one": "Illinois"
        },
        "suggested": true,
        "suggested_for": [
            "Bartender",
            "Data entry clerk"
        ]
    }
}

To update the value of the credentials please use 'Update Custom Requirement' under this api:

https://docs.fromwolf.com/job-seekers-account/custom-onboarding-api