VCSP client docs

`vericlient.vcsp.client.VcspClient` ¶

Bases: Client

Class to interact with the VCSP API.

Source code in src/vericlient/vcsp/client.py

class VcspClient(Client):
    """Class to interact with the VCSP API."""

    def __init__(
            self,
            api: str = APIs.VCSP.value,
            apikey: str | None = None,
            timeout: int | None = None,
            environment: str | None = None,
            location: str | None = None,
            url: str | None = None,
            headers: dict | None = None,
    ) -> None:
        """Create the VcspClient class.

        Args:
            api: The API to use
            apikey: The API key to use
            timeout: The timeout to use in the requests
            environment: The environment to use
            location: The location to use
            url: The URL to use in case of a custom target
            headers: The headers to be used in the requests

        """
        super().__init__(
            api=api,
            apikey=apikey,
            timeout=timeout,
            environment=environment,
            location=location,
            url=url,
            headers=headers,
        )
        self._exceptions = {
            "empty_file": EmptyFileError,
            "invalid_claims": InvalidClaimsError,
            "invalid_assurance": InvalidAssuranceError,
            "invalid_tags": InvalidTagsError,
            "invalid_credential_configuration_urn": InvalidCredentialConfigurationUrnError,
            "invalid_assurance_method_urn": InvalidAssuranceMethodUrnError,
            "credential_configuration_urn_already_assigned": CredentialConfigurationUrnAlreadyAssignedError,
            "invalid_audio_format": InvalidAudioFormatError,
            "invalid_signal_noise_ratio": InvalidSnrError,
            "voice_duration_is_not_enough": VoiceDurationIsNotEnoughError,
            "insufficient_quality": InsufficientQualityError,
            "face_not_found": FaceNotFoundError,
            "more_than_one_face": MoreThanOneFaceError,
            "face_too_small_for_ias": FaceTooSmallError,
            "face_alignment": FaceAlignmentError,
            "assurance_validation_error": AssuranceValidationError,
            "assurance_method_not_found": AssuranceMethodNotFoundError,
            "account_not_found": AccountNotFoundError,
            "credential_not_found": CredentialNotFoundError,
            "request_validation": RequestValidationError,
            "unsupported_media_type": UnsupportedMediaTypeError,
        }

    def alive(self) -> bool:
        """Check if the service is alive.

        Returns
            bool: True if the service is alive, False otherwise

        """
        response = self._get(endpoint=VcspEndpoints.ALIVE.value)
        accepted_status_code = 204
        return response.status_code == accepted_status_code

    def _handle_error_response(self, response: Response) -> None:
        """Handle error responses from the API."""
        response_json = response.json()

        exception = response_json.get("error")
        if not exception or exception not in self._exceptions:
            self._raise_server_error(response)

        handler = self._exceptions[exception]
        raise handler()

    def get_credential_configurations(self) -> CredentialConfigurationsOutput:
        """Get all credential configurations.

        Returns:
            CredentialConfigurationsOutput: The output of the credential configurations

        """
        endpoint = VcspEndpoints.CREDENTIAL_CONFIGURATIONS.value
        response = self._get(endpoint=endpoint)
        return CredentialConfigurationsOutput(
            status_code=response.status_code,
            credential_configurations=response.json(),
        )

    def get_assurance_methods(self) -> AssuranceMethodsOutput:
        """Get all assurance methods.

        Returns:
            AssuranceMethodsOutput: The output of the assurance methods

        """
        endpoint = VcspEndpoints.ASSURANCE_METHODS.value
        response = self._get(endpoint=endpoint)
        return AssuranceMethodsOutput(
            status_code=response.status_code,
            assurance_methods=response.json(),
        )

    def get_assurance_method_info(self, data_model: AssuranceMethodInput) -> AssuranceMethodOutput:
        """Get an assurance method.

        Args:
            data_model: The input to get the assurance method

        Returns:
            AssuranceMethodOutput: The output of the assurance method

        """
        endpoint = VcspEndpoints.ASSURANCE_METHOD_URN.value.replace("<urn>", data_model.urn)
        response = self._get(endpoint=endpoint)
        return AssuranceMethodOutput(status_code=response.status_code, **response.json())

    def enroll_subject(self, data_model: EnrollmentInput) -> EnrollmentOutput:
        """Enroll a subject.

        Args:
            data_model: The input to enroll the subject

        Returns:
            EnrollmentOutput: The output of the enrollment

        Raises:
            EmptyFileError: If the file is empty
            InvalidClaimsError: If the claims are invalid
            InvalidAssuranceError: If the assurance is invalid
            InvalidTagsError: If the tags are invalid
            InvalidCredentialConfigurationUrnError: If the credential configuration urn is invalid
            InvalidAssuranceMethodUrnError: If the assurance method urn is invalid
            CredentialConfigurationUrnAlreadyAssignedError: If the credential configuration urn is already assigned
            InvalidAudioFormatError: If the audio format is invalid
            InvalidSnrError: If the signal noise ratio is invalid
            VoiceDurationIsNotEnoughError: If the voice duration is not enough
            InsufficientQualityError: If the quality is insufficient
            FaceAlignmentError: If the face is not aligned
            FaceNotFoundError: If the face is not found
            FaceTooSmallError: If the face is too small
            MoreThanOneFaceError: If there is more than one face
            AssuranceValidationError: If the assurance is invalid
            RequestValidationError: If the request is invalid
            UnsupportedMediaTypeError: If the media type is not supported

        """
        endpoint = VcspEndpoints.ENROLLMENTS.value
        sample = self._get_sample(data_model.sample)
        files = {"sample": sample}
        data = {"applicant": json.dumps(data_model.applicant.model_dump(exclude_none=True))}
        response = self._post(
            endpoint=endpoint,
            files=files,
            data=data,
        )
        return EnrollmentOutput(status_code=response.status_code, **response.json())

    def _get_sample(self, sample: str | bytes) -> tuple[str, bytes, str]:
        """Given a sample, return the filename, the file and the content type."""
        if isinstance(sample, str):
            filename = os.path.basename(sample)
            with open(sample, "rb") as f:
                file = f.read()
            content_type = mimetypes.guess_type(sample)[0]
        if isinstance(sample, bytes):
            filename = "sample"
            file = sample
            content_type = mimetypes.guess_type(sample)[0]
        return filename, file, content_type

    def get_account(self, data_model: GetAccountInput) -> GetAccountOutput:
        """Get an account.

        Args:
            data_model: The input to get the account

        Returns:
            GetAccountOutput: The output of the account

        Raises:
            AccountNotFoundError: If the account is not found

        """
        endpoint = VcspEndpoints.ACCOUNTS.value.replace("<subject_id>", data_model.subject_id)
        response = self._get(endpoint=endpoint)
        return GetAccountOutput(status_code=response.status_code, **response.json())

    def delete_account(self, data_model: DeleteAccountInput) -> None:
        """Delete an account.

        Args:
            data_model: The input to delete the account

        Raises:
            AccountNotFoundError: If the account is not found

        """
        endpoint = VcspEndpoints.ACCOUNTS.value.replace("<subject_id>", data_model.subject_id)
        self._delete(endpoint=endpoint)

    def get_all_subject_credentials(self, data_model: GetCredentialsInput) -> GetCredentialsOutput:
        """Get all credentials for a subject.

        Args:
            data_model: The input to get all credentials for the subject

        Returns:
            GetCredentialsOutput: The output of the credentials

        Raises:
            AccountNotFoundError: If the account is not found

        """
        endpoint = VcspEndpoints.CREDENTIALS.value.replace("<subject_id>", data_model.subject_id)
        response = self._get(endpoint=endpoint)
        return GetCredentialsOutput(credentials=response.json(), status_code=response.status_code)

    def get_credential(self, data_model: GetCredentialInput) -> GetCredentialOutput:
        """Get a credential.

        Args:
            data_model: The input to get the credential

        Returns:
            GetCredentialOutput: The output of the credential

        Raises:
            CredentialNotFoundError: If the credential is not found
            AccountNotFoundError: If the account is not found

        """
        endpoint = VcspEndpoints.CREDENTIAL_ID.value.replace("<subject_id>", data_model.subject_id)
        endpoint = endpoint.replace("<credential_id>", data_model.credential_id)
        response = self._get(endpoint=endpoint)
        return GetCredentialOutput(status_code=response.status_code, **response.json())

    def delete_credential(self, data_model: DeleteCredentialInput) -> None:
        """Delete a credential.

        Args:
            data_model: The input to delete the credential

        """
        endpoint = VcspEndpoints.CREDENTIAL_ID.value.replace("<subject_id>", data_model.subject_id)
        endpoint = endpoint.replace("<credential_id>", data_model.credential_id)
        self._delete(endpoint=endpoint)

`init(api=APIs.VCSP.value, apikey=None, timeout=None, environment=None, location=None, url=None, headers=None)` ¶

Create the VcspClient class.

Parameters:

Name	Type	Description	Default
`api`	`str`	The API to use	`VCSP.value`
`apikey`	`str \| None`	The API key to use	`None`
`timeout`	`int \| None`	The timeout to use in the requests	`None`
`environment`	`str \| None`	The environment to use	`None`
`location`	`str \| None`	The location to use	`None`
`url`	`str \| None`	The URL to use in case of a custom target	`None`
`headers`	`dict \| None`	The headers to be used in the requests	`None`

Source code in src/vericlient/vcsp/client.py

def __init__(
        self,
        api: str = APIs.VCSP.value,
        apikey: str | None = None,
        timeout: int | None = None,
        environment: str | None = None,
        location: str | None = None,
        url: str | None = None,
        headers: dict | None = None,
) -> None:
    """Create the VcspClient class.

    Args:
        api: The API to use
        apikey: The API key to use
        timeout: The timeout to use in the requests
        environment: The environment to use
        location: The location to use
        url: The URL to use in case of a custom target
        headers: The headers to be used in the requests

    """
    super().__init__(
        api=api,
        apikey=apikey,
        timeout=timeout,
        environment=environment,
        location=location,
        url=url,
        headers=headers,
    )
    self._exceptions = {
        "empty_file": EmptyFileError,
        "invalid_claims": InvalidClaimsError,
        "invalid_assurance": InvalidAssuranceError,
        "invalid_tags": InvalidTagsError,
        "invalid_credential_configuration_urn": InvalidCredentialConfigurationUrnError,
        "invalid_assurance_method_urn": InvalidAssuranceMethodUrnError,
        "credential_configuration_urn_already_assigned": CredentialConfigurationUrnAlreadyAssignedError,
        "invalid_audio_format": InvalidAudioFormatError,
        "invalid_signal_noise_ratio": InvalidSnrError,
        "voice_duration_is_not_enough": VoiceDurationIsNotEnoughError,
        "insufficient_quality": InsufficientQualityError,
        "face_not_found": FaceNotFoundError,
        "more_than_one_face": MoreThanOneFaceError,
        "face_too_small_for_ias": FaceTooSmallError,
        "face_alignment": FaceAlignmentError,
        "assurance_validation_error": AssuranceValidationError,
        "assurance_method_not_found": AssuranceMethodNotFoundError,
        "account_not_found": AccountNotFoundError,
        "credential_not_found": CredentialNotFoundError,
        "request_validation": RequestValidationError,
        "unsupported_media_type": UnsupportedMediaTypeError,
    }

`alive()` ¶

Check if the service is alive.

Returns bool: True if the service is alive, False otherwise

Source code in src/vericlient/vcsp/client.py

def alive(self) -> bool:
    """Check if the service is alive.

    Returns
        bool: True if the service is alive, False otherwise

    """
    response = self._get(endpoint=VcspEndpoints.ALIVE.value)
    accepted_status_code = 204
    return response.status_code == accepted_status_code

`delete_account(data_model)` ¶

Delete an account.

Parameters:

Name	Type	Description	Default
`data_model`	`DeleteAccountInput`	The input to delete the account	required

Raises:

Type	Description
`AccountNotFoundError`	If the account is not found

Source code in src/vericlient/vcsp/client.py

def delete_account(self, data_model: DeleteAccountInput) -> None:
    """Delete an account.

    Args:
        data_model: The input to delete the account

    Raises:
        AccountNotFoundError: If the account is not found

    """
    endpoint = VcspEndpoints.ACCOUNTS.value.replace("<subject_id>", data_model.subject_id)
    self._delete(endpoint=endpoint)

`delete_credential(data_model)` ¶

Delete a credential.

Parameters:

Name	Type	Description	Default
`data_model`	`DeleteCredentialInput`	The input to delete the credential	required

Source code in src/vericlient/vcsp/client.py

def delete_credential(self, data_model: DeleteCredentialInput) -> None:
    """Delete a credential.

    Args:
        data_model: The input to delete the credential

    """
    endpoint = VcspEndpoints.CREDENTIAL_ID.value.replace("<subject_id>", data_model.subject_id)
    endpoint = endpoint.replace("<credential_id>", data_model.credential_id)
    self._delete(endpoint=endpoint)

`enroll_subject(data_model)` ¶

Enroll a subject.

Parameters:

Name	Type	Description	Default
`data_model`	`EnrollmentInput`	The input to enroll the subject	required

Returns:

Name	Type	Description
`EnrollmentOutput`	`EnrollmentOutput`	The output of the enrollment

Raises:

Type	Description
`EmptyFileError`	If the file is empty
`InvalidClaimsError`	If the claims are invalid
`InvalidAssuranceError`	If the assurance is invalid
`InvalidTagsError`	If the tags are invalid
`InvalidCredentialConfigurationUrnError`	If the credential configuration urn is invalid
`InvalidAssuranceMethodUrnError`	If the assurance method urn is invalid
`CredentialConfigurationUrnAlreadyAssignedError`	If the credential configuration urn is already assigned
`InvalidAudioFormatError`	If the audio format is invalid
`InvalidSnrError`	If the signal noise ratio is invalid
`VoiceDurationIsNotEnoughError`	If the voice duration is not enough
`InsufficientQualityError`	If the quality is insufficient
`FaceAlignmentError`	If the face is not aligned
`FaceNotFoundError`	If the face is not found
`FaceTooSmallError`	If the face is too small
`MoreThanOneFaceError`	If there is more than one face
`AssuranceValidationError`	If the assurance is invalid
`RequestValidationError`	If the request is invalid
`UnsupportedMediaTypeError`	If the media type is not supported

Source code in src/vericlient/vcsp/client.py

def enroll_subject(self, data_model: EnrollmentInput) -> EnrollmentOutput:
    """Enroll a subject.

    Args:
        data_model: The input to enroll the subject

    Returns:
        EnrollmentOutput: The output of the enrollment

    Raises:
        EmptyFileError: If the file is empty
        InvalidClaimsError: If the claims are invalid
        InvalidAssuranceError: If the assurance is invalid
        InvalidTagsError: If the tags are invalid
        InvalidCredentialConfigurationUrnError: If the credential configuration urn is invalid
        InvalidAssuranceMethodUrnError: If the assurance method urn is invalid
        CredentialConfigurationUrnAlreadyAssignedError: If the credential configuration urn is already assigned
        InvalidAudioFormatError: If the audio format is invalid
        InvalidSnrError: If the signal noise ratio is invalid
        VoiceDurationIsNotEnoughError: If the voice duration is not enough
        InsufficientQualityError: If the quality is insufficient
        FaceAlignmentError: If the face is not aligned
        FaceNotFoundError: If the face is not found
        FaceTooSmallError: If the face is too small
        MoreThanOneFaceError: If there is more than one face
        AssuranceValidationError: If the assurance is invalid
        RequestValidationError: If the request is invalid
        UnsupportedMediaTypeError: If the media type is not supported

    """
    endpoint = VcspEndpoints.ENROLLMENTS.value
    sample = self._get_sample(data_model.sample)
    files = {"sample": sample}
    data = {"applicant": json.dumps(data_model.applicant.model_dump(exclude_none=True))}
    response = self._post(
        endpoint=endpoint,
        files=files,
        data=data,
    )
    return EnrollmentOutput(status_code=response.status_code, **response.json())

`get_account(data_model)` ¶

Get an account.

Parameters:

Name	Type	Description	Default
`data_model`	`GetAccountInput`	The input to get the account	required

Returns:

Name	Type	Description
`GetAccountOutput`	`GetAccountOutput`	The output of the account

Raises:

Type	Description
`AccountNotFoundError`	If the account is not found

Source code in src/vericlient/vcsp/client.py

def get_account(self, data_model: GetAccountInput) -> GetAccountOutput:
    """Get an account.

    Args:
        data_model: The input to get the account

    Returns:
        GetAccountOutput: The output of the account

    Raises:
        AccountNotFoundError: If the account is not found

    """
    endpoint = VcspEndpoints.ACCOUNTS.value.replace("<subject_id>", data_model.subject_id)
    response = self._get(endpoint=endpoint)
    return GetAccountOutput(status_code=response.status_code, **response.json())

`get_all_subject_credentials(data_model)` ¶

Get all credentials for a subject.

Parameters:

Name	Type	Description	Default
`data_model`	`GetCredentialsInput`	The input to get all credentials for the subject	required

Returns:

Name	Type	Description
`GetCredentialsOutput`	`GetCredentialsOutput`	The output of the credentials

Raises:

Type	Description
`AccountNotFoundError`	If the account is not found

Source code in src/vericlient/vcsp/client.py

def get_all_subject_credentials(self, data_model: GetCredentialsInput) -> GetCredentialsOutput:
    """Get all credentials for a subject.

    Args:
        data_model: The input to get all credentials for the subject

    Returns:
        GetCredentialsOutput: The output of the credentials

    Raises:
        AccountNotFoundError: If the account is not found

    """
    endpoint = VcspEndpoints.CREDENTIALS.value.replace("<subject_id>", data_model.subject_id)
    response = self._get(endpoint=endpoint)
    return GetCredentialsOutput(credentials=response.json(), status_code=response.status_code)

`get_assurance_method_info(data_model)` ¶

Get an assurance method.

Parameters:

Name	Type	Description	Default
`data_model`	`AssuranceMethodInput`	The input to get the assurance method	required

Returns:

Name	Type	Description
`AssuranceMethodOutput`	`AssuranceMethodOutput`	The output of the assurance method

Source code in src/vericlient/vcsp/client.py

def get_assurance_method_info(self, data_model: AssuranceMethodInput) -> AssuranceMethodOutput:
    """Get an assurance method.

    Args:
        data_model: The input to get the assurance method

    Returns:
        AssuranceMethodOutput: The output of the assurance method

    """
    endpoint = VcspEndpoints.ASSURANCE_METHOD_URN.value.replace("<urn>", data_model.urn)
    response = self._get(endpoint=endpoint)
    return AssuranceMethodOutput(status_code=response.status_code, **response.json())

`get_assurance_methods()` ¶

Get all assurance methods.

Returns:

Name	Type	Description
`AssuranceMethodsOutput`	`AssuranceMethodsOutput`	The output of the assurance methods

Source code in src/vericlient/vcsp/client.py

def get_assurance_methods(self) -> AssuranceMethodsOutput:
    """Get all assurance methods.

    Returns:
        AssuranceMethodsOutput: The output of the assurance methods

    """
    endpoint = VcspEndpoints.ASSURANCE_METHODS.value
    response = self._get(endpoint=endpoint)
    return AssuranceMethodsOutput(
        status_code=response.status_code,
        assurance_methods=response.json(),
    )

`get_credential(data_model)` ¶

Get a credential.

Parameters:

Name	Type	Description	Default
`data_model`	`GetCredentialInput`	The input to get the credential	required

Returns:

Name	Type	Description
`GetCredentialOutput`	`GetCredentialOutput`	The output of the credential

Raises:

Type	Description
`CredentialNotFoundError`	If the credential is not found
`AccountNotFoundError`	If the account is not found

Source code in src/vericlient/vcsp/client.py

def get_credential(self, data_model: GetCredentialInput) -> GetCredentialOutput:
    """Get a credential.

    Args:
        data_model: The input to get the credential

    Returns:
        GetCredentialOutput: The output of the credential

    Raises:
        CredentialNotFoundError: If the credential is not found
        AccountNotFoundError: If the account is not found

    """
    endpoint = VcspEndpoints.CREDENTIAL_ID.value.replace("<subject_id>", data_model.subject_id)
    endpoint = endpoint.replace("<credential_id>", data_model.credential_id)
    response = self._get(endpoint=endpoint)
    return GetCredentialOutput(status_code=response.status_code, **response.json())

`get_credential_configurations()` ¶

Get all credential configurations.

Returns:

Name	Type	Description
`CredentialConfigurationsOutput`	`CredentialConfigurationsOutput`	The output of the credential configurations

Source code in src/vericlient/vcsp/client.py

def get_credential_configurations(self) -> CredentialConfigurationsOutput:
    """Get all credential configurations.

    Returns:
        CredentialConfigurationsOutput: The output of the credential configurations

    """
    endpoint = VcspEndpoints.CREDENTIAL_CONFIGURATIONS.value
    response = self._get(endpoint=endpoint)
    return CredentialConfigurationsOutput(
        status_code=response.status_code,
        credential_configurations=response.json(),
    )

`vericlient.vcsp.models` ¶

Module to define the models for the VCSP API.

`Applicant` ¶

Bases: BaseModel

Base class for the Applicant.

Attributes:

Name	Type	Description
`subject_id`	`str \| None`	The subject_id of the applicant (optional). If not provided, it will be generated by the system and returned in the response
`credential_configuration_urn`	`str`	The credential configuration urn
`tags`	`list[str] \| None`	The tags of the applicant
`claims`	`dict \| None`	The claims of the applicant
`assurance_method_urn`	`str`	The assurance method urn
`assurance`	`dict`	The assurance of the applicant

Source code in src/vericlient/vcsp/models.py

class Applicant(BaseModel):
    """Base class for the Applicant.

    Attributes:
        subject_id: The subject_id of the applicant (optional). If not provided, it will
            be generated by the system and returned in the response
        credential_configuration_urn: The credential configuration urn
        tags: The tags of the applicant
        claims: The claims of the applicant
        assurance_method_urn: The assurance method urn
        assurance: The assurance of the applicant

    """

    subject_id: str | None = None
    credential_configuration_urn: str
    tags: list[str] | None = []
    claims: dict | None = {}
    assurance_method_urn: str
    assurance: dict

`AssuranceMethodInput` ¶

Bases: BaseModel

Input class for the assurance method endpoint.

Attributes:

Name	Type	Description
`urn`	`str`	The urn of the assurance method

Source code in src/vericlient/vcsp/models.py

class AssuranceMethodInput(BaseModel):
    """Input class for the assurance method endpoint.

    Attributes:
        urn: The urn of the assurance method

    """

    urn: str

`AssuranceMethodOutput` ¶

Bases: VcspResponse

Output class for the assurance method endpoint.

Attributes:

Name	Type	Description
`urn`	`str`	The urn of the assurance method
`schema`	`AssuranceMethodSchema`	The schema of the assurance method

Source code in src/vericlient/vcsp/models.py

class AssuranceMethodOutput(VcspResponse):
    """Output class for the assurance method endpoint.

    Attributes:
        urn: The urn of the assurance method
        schema: The schema of the assurance method

    """

    urn: str
    schema: AssuranceMethodSchema

`AssuranceMethodSchema` ¶

Bases: BaseModel

Schema class for the assurance method.

Attributes:

Name	Type	Description
`$schema`		The schema of the assurance method
`title`	`str`	The title of the assurance method
`type`	`str`	The type of the assurance method
`properties`	`dict`	The properties of the assurance method
`required`	`list[str] \| None`	The required properties of the assurance method
`additionalProperties`	`bool`	Whether additional properties are allowed

Source code in src/vericlient/vcsp/models.py

class AssuranceMethodSchema(BaseModel):
    """Schema class for the assurance method.

    Attributes:
        $schema: The schema of the assurance method
        title: The title of the assurance method
        type: The type of the assurance method
        properties: The properties of the assurance method
        required: The required properties of the assurance method
        additionalProperties: Whether additional properties are allowed

    """

    schema: str = Field(alias="$schema")
    title: str
    type: str
    properties: dict
    required: list[str] | None = None
    additionalProperties: bool      # noqa: N815

`AssuranceMethodsOutput` ¶

Bases: VcspResponse

Output class for the assurance methods endpoint.

Attributes:

Name	Type	Description
`assurance_methods`	`list[str]`	The assurance methods

Source code in src/vericlient/vcsp/models.py

class AssuranceMethodsOutput(VcspResponse):
    """Output class for the assurance methods endpoint.

    Attributes:
        assurance_methods: The assurance methods

    """

    assurance_methods: list[str]

`CredentialConfigurationsOutput` ¶

Bases: VcspResponse

Output class for the credential configurations endpoint.

Attributes:

Name	Type	Description
`credential_configurations`	`list[str]`	The credential configurations

Source code in src/vericlient/vcsp/models.py

class CredentialConfigurationsOutput(VcspResponse):
    """Output class for the credential configurations endpoint.

    Attributes:
        credential_configurations: The credential configurations

    """

    credential_configurations: list[str]

`CredentialInput` ¶

Bases: BaseModel

Input class to define a credential.

Attributes:

Name	Type	Description
`credential_id`	`str`	The credential_id of the applicant

Source code in src/vericlient/vcsp/models.py

class CredentialInput(BaseModel):
    """Input class to define a credential.

    Attributes:
        credential_id: The credential_id of the applicant

    """

    credential_id: str

`DeleteAccountInput` ¶

Bases: SubjectInput

Input class for the delete account endpoint.

Attributes:

Name	Type	Description
`subject_id`		The account_id to delete

Source code in src/vericlient/vcsp/models.py

class DeleteAccountInput(SubjectInput):
    """Input class for the delete account endpoint.

    Attributes:
        subject_id: The account_id to delete

    """

`DeleteCredentialInput` ¶

Bases: SubjectInput, CredentialInput

Input class for the delete credential endpoint.

Attributes:

Name	Type	Description
`credential_id`		The credential_id to delete
`subject_id`		The subject from which the credential will be deleted

Source code in src/vericlient/vcsp/models.py

class DeleteCredentialInput(SubjectInput, CredentialInput):
    """Input class for the delete credential endpoint.

    Attributes:
        credential_id: The credential_id to delete
        subject_id: The subject from which the credential will be deleted

    """

`DeleteSubjectInput` ¶

Bases: SubjectInput

Input class for the delete account endpoint.

Attributes:

Name	Type	Description
`subject_id`		The account_id to delete

Source code in src/vericlient/vcsp/models.py

class DeleteSubjectInput(SubjectInput):
    """Input class for the delete account endpoint.

    Attributes:
        subject_id: The account_id to delete

    """

`EnrollmentInput` ¶

Bases: BaseModel

Input class for the enrollment endpoint.

Attributes:

Name	Type	Description
`sample`	`str \| bytes`	The sample to generate the credential with. It can be a path to a file or a bytes object with the audio content
`applicant`	`Applicant`	The applicant to enroll

Source code in src/vericlient/vcsp/models.py

class EnrollmentInput(BaseModel):
    """Input class for the enrollment endpoint.

    Attributes:
        sample: The sample to generate the credential with.
            It can be a path to a file or a bytes object
            with the audio content
        applicant: The applicant to enroll

    """

    sample: str | bytes
    applicant: Applicant

    @field_validator("sample")
    def must_be_str_or_bytes(cls, value: object):
        if not isinstance(value, (str, bytes)):
            error = "sample must be a string or a bytes object"
            raise TypeError(error)
        return value

    class Config:
        arbitrary_types_allowed = True

`EnrollmentOutput` ¶

Bases: BaseModel

Output class for the enrollment endpoint.

Attributes:

Name	Type	Description
`credential_id`	`str`	The credential_id of the applicant
`subject_id`	`str`	The subject_id of the applicant

Source code in src/vericlient/vcsp/models.py

class EnrollmentOutput(BaseModel):
    """Output class for the enrollment endpoint.

    Attributes:
        credential_id: The credential_id of the applicant
        subject_id: The subject_id of the applicant

    """

    credential_id: str
    subject_id: str

`GetAccountInput` ¶

Bases: SubjectInput

Input class for the get account endpoint.

Attributes:

Name	Type	Description
`subject_id`		The account_id to get

Source code in src/vericlient/vcsp/models.py

class GetAccountInput(SubjectInput):
    """Input class for the get account endpoint.

    Attributes:
        subject_id: The account_id to get

    """

`GetAccountOutput` ¶

Bases: VcspResponse

Output class for the get account endpoint.

Attributes:

Name	Type	Description
`credentials`	`list[str]`	The credentials of the applicant
`updated_at`	`str`	The updated_at date
`created_at`	`str`	The created_at date
`subject_id`	`str`	The subject_id of the applicant

Source code in src/vericlient/vcsp/models.py

class GetAccountOutput(VcspResponse):
    """Output class for the get account endpoint.

    Attributes:
        credentials: The credentials of the applicant
        updated_at: The updated_at date
        created_at: The created_at date
        subject_id: The subject_id of the applicant

    """

    credentials: list[str]
    updated_at: str
    created_at: str
    subject_id: str

`GetCredentialInput` ¶

Bases: SubjectInput, CredentialInput

Input class for the get a specific credential endpoint.

Attributes:

Name	Type	Description
`subject_id`		The subject_id to get the credential from
`credential_id`		The credential_id to get

Source code in src/vericlient/vcsp/models.py

class GetCredentialInput(SubjectInput, CredentialInput):
    """Input class for the get a specific credential endpoint.

    Attributes:
        subject_id: The subject_id to get the credential from
        credential_id: The credential_id to get

    """

`GetCredentialOutput` ¶

Bases: BaseModel

Output class for the get credential endpoint.

Attributes:

Name	Type	Description
`sample`	`Sample`	The sample of the applicant
`groups`	`list[str]`	The groups of the applicant
`issuer`	`str`	The issuer
`id`	`str`	The id of the applicant
`updated_at`	`str`	The updated_at date
`created_at`	`str`	The created_at date
`valid_from`	`str`	The valid_from date
`valid_until`	`str`	The valid_until date
`credential_configuration_urn`	`str`	The credential_configuration_urn
`tags`	`list[str]`	The tags of the applicant
`claims`	`dict`	The claims of the applicant

Source code in src/vericlient/vcsp/models.py

class GetCredentialOutput(BaseModel):
    """Output class for the get credential endpoint.

    Attributes:
        sample: The sample of the applicant
        groups: The groups of the applicant
        issuer: The issuer
        id: The id of the applicant
        updated_at: The updated_at date
        created_at: The created_at date
        valid_from: The valid_from date
        valid_until: The valid_until date
        credential_configuration_urn: The credential_configuration_urn
        tags: The tags of the applicant
        claims: The claims of the applicant

    """

    sample: Sample
    groups: list[str]
    issuer: str
    id: str
    updated_at: str
    created_at: str
    valid_from: str
    valid_until: str
    credential_configuration_urn: str
    tags: list[str]
    claims: dict

`GetCredentialsInput` ¶

Bases: SubjectInput

Input class for the get all credentials from a subject endpoint.

Attributes:

Name	Type	Description
`subject_id`		The account_id to get the credentials from

Source code in src/vericlient/vcsp/models.py

class GetCredentialsInput(SubjectInput):
    """Input class for the get all credentials from a subject endpoint.

    Attributes:
        subject_id: The account_id to get the credentials from

    """

`GetCredentialsOutput` ¶

Bases: VcspResponse

Output class for the get all credentials from a subject endpoint.

Attributes:

Name	Type	Description
`credentials`	`list[GetCredentialOutput]`	The credentials of the applicant

Source code in src/vericlient/vcsp/models.py

class GetCredentialsOutput(VcspResponse):
    """Output class for the get all credentials from a subject endpoint.

    Attributes:
        credentials: The credentials of the applicant

    """

    credentials: list[GetCredentialOutput]

`Sample` ¶

Bases: BaseModel

Base class for the Sample.

Attributes:

Name	Type	Description
`valid_from`	`str`	The date from which the sample is valid
`valid_until`	`str`	The date until which the sample is valid
`type`	`str`	The type of the sample, e.g. "voice", "face"
`content_type`	`str`	The content type of the sample, e.g. "audio/wav", "image/jpeg"
`analysis`	`dict`	The analysis of the sample

Source code in src/vericlient/vcsp/models.py

class Sample(BaseModel):
    """Base class for the Sample.

    Attributes:
        valid_from: The date from which the sample is valid
        valid_until: The date until which the sample is valid
        type: The type of the sample, e.g. "voice", "face"
        content_type: The content type of the sample, e.g. "audio/wav", "image/jpeg"
        analysis: The analysis of the sample

    """

    valid_from: str
    valid_until: str
    type: str
    content_type: str
    analysis: dict

`SubjectInput` ¶

Bases: BaseModel

Input class to define a subject.

Attributes:

Name	Type	Description
`subject_id`	`str`	The subject_id of the applicant

Source code in src/vericlient/vcsp/models.py

class SubjectInput(BaseModel):
    """Input class to define a subject.

    Attributes:
        subject_id: The subject_id of the applicant

    """

    subject_id: str

`VcspResponse` ¶

Bases: BaseModel

Base class for the VCSP API responses.

Attributes:

Name	Type	Description
`status_code`	`int`	The status code of the response

Source code in src/vericlient/vcsp/models.py

class VcspResponse(BaseModel):
    """Base class for the VCSP API responses.

    Attributes:
        status_code: The status code of the response

    """

    status_code: int

`vericlient.vcsp.exceptions` ¶

Module to define the exceptions for the VCSP API.