Validations

Get validations

POST https://www.pepdata.com/api/get_validations

Endpoint to get validations.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
page	number	Page of the validations. Default: 1
source	string	Source of the validations. Default: all Possible values: all upload manual
status	string	Status of the validations. Default: all Possible values: all complete complete_identified complete_not_identified needs_attention incomplete
id	string	Id of the validation
id_custom	string	Custom id of the validation
sort_by	string	Property used for sorting validations Possible values: added_at determined_at name
sort_dir	string	Descending or ascending sorting of validations Possible values: desc asc

200 Validations obtained successfully.

{
    "version": 0.1,
    "timestamp": 1688640113263,
    "data": {
        "count": 2,
        "total": 2,
        "page": 1,
        "max_results_per_page": 50,
        "items": [
            {
                "id": "2a206d4a-0a5d-4a04-9a0c-cadae6e2cffa", 
                "vatin": "628579388",
                "source": "Automatic",
                "name": "John Marcus Smith",
                "birth_date": "1986-01-08",
                "id_country_nationality": "GBR",
                "id_country_residence": null,
                "decision": null,
                "id_iperson": 9bbf3184-8ced-4095-9cad-7e4dc664c9ee,
                "iperson_classifications": [
                    "PEP",
                    "Family Member",
                    "Associate"
                ],
                "relations": [
                    {
                        "name": "António Silva",
                        "vatin": null,
                        "id_iperson": "5e809bc7-927e-3dc3-0ff8-ab9022843a5a",
                        "id_iorganization": null,
                        "relationship_type": "representative",
                        "id_relationship_info": "d0a4effc-576e-a4a2-f32e-9e594d7144ba"
                    }
                ],
                "added_by": "cd9f4a64-ab25-4efb-bf31-323ee2280095",
                "added_at": 1688639245750,
                "determined_at": null,
                "determined_by": null,
                "identifiable_country": null,
                "id_organization": "6cc1b6c1-33a9-4095-a4a4-aaca0db8d647",
                "id_custom": null,
                "entity_type": "individual",
                "id_iorganization": null,
                "adverse_media_searched_at": null,
                "alerts": [],
                "country_nationality": "United Kingdom"
            },
            {
                "id": "a58dd84e-7e89-9904-5acf-2b1fbfcc8a31",
                "vatin": "595596160",
                "source": "Automatic",
                "name": "Maria Edite Nieto",
                "birth_date": null,
                "id_country_nationality": "PT",
                "id_country_residence": null,
                "decision": null,
                "id_iperson": null,
                "iperson_classifications": null,
                "relations": null,
                "added_by": "cd9f4a64-ab25-4efb-bf31-323ee2280095",
                "added_at": 1688639245750,
                "determined_at": null,
                "determined_by": null,
                "identifiable_country": null,
                "id_organization": "6cc1b6c1-33a9-4095-a4a4-aaca0db8d647",
                "id_custom": null,
                "entity_type": "individual",
                "id_iorganization": null,
                "adverse_media_searched_at": null,
                "judicial_processes_searched_at": null,
                "alerts": [
                    {
                        "id": "1d71c856-8dde-4815-9dce-1683e176a6f1",
                        "added_at": 1689244974065,
                        "resolved_by": null,
                        "resolved_at": null,
                        "reasons": [
                            "There is a new result that might match this validation: Mary Elizabeth Smith"
                        ]
                    }
                ],
                "country_nationality": "Portugal"
            },
        ]
    }
}

Label

• id: validation id.

• vatin: vat number of the validation.

• source: validation source.

• name: validation name.

• birth_date: birth date of the validation.

• id_country_nationality: code of the nationality country, in ISO 3166-1 alpha-2 format.

• id_country_residence: code of the residence country, in ISO 3166-1 alpha-2 format.

• decision: boolean that describes whether there was a match with an identifiable person.

• id_iperson: id of the corresponding identifiable person. null if there is no match.

• iperson_classifications: list of classifications of the identifiable person, possible values:

  • Asociate

  • Family Member

  • Holder of Other Political or Public Positions

  • PEP

  • Sanctioned (EU)

  • Sanctioned (HM Treasury)

  • Sanctioned (OFAC)

  • Sanctioned (UN)

• relations: relationships where the validation is associated. It contains the following properties:

  • name: relationship name.

  • vatin: vat number of the relationship.

  • id_iperson: id of the identifiable person associated with the relationship.

  • id_iorganization: id of the identifiable organization associated with the relationship.

  • relationship_type: type of the relationship. Possible values:

    • representative

    • manager

    • beneficiary

    • beneficial_owner

  • id_relationship_info: id of the relationship.

• added_by: id of the user who added the validation.

• added_at: date the validation was added, as a number of milliseconds since January 1, 1970 00:00:00 UTC.

• determined_at: date the validation was determined, as a number of milliseconds since January 1, 1970 00:00:00 UTC.

• determined_by: id of the user who determined the validation.

• identifiable_country: boolean that describes whether the country of the validation country is sanctioned.

• id_organization: id of the organization who created the validation.

• id_custom: customizable id entered by the user.

• entity_type: type of validation that could be: "individual" or "organization".

• id_iorganization: id of the correspondent identifiable organization. null in case there is no match.

• adverse_media_searched_at: date of the last search of adverse media, associated with the validation name.

• judicial_processes_searched_at: date of the last search of judicial processes associated with the validation name.

• alerts: alerts related to the validation that are still unresolved.

• country_nationality: nationality country.

Export validations

POST https://www.pepdata.com/api/export_validations

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
from*	int	Start date of the filter, by the form of milliseconds number from 1st of January 1970 00:00:00 UTC.
until*	int	End date of the filter, by the form of milliseconds number from 1st of January 1970 00:00:00 UTC.
status	string	Status of the validations Default: all Possible values: all complete complete_identified, complete_not_identified needs_attention incomplete
format	string	Exported file format Default: xlsx Possible values: xlsx csv
export_by	string	Export validations by date of addition or date of determination. Default: added_at Possible values: added_at determined_at
timezone	string	Timezone of the timestamps used in the filters Default: Europe/Lisbon

Response

200: OK file exported with succes

9KB

validations from 01-07-2024 a 29-07-2024.xlsx

Example of the export validations file

400: Bad Request Empty required fields

{
   "message": {
        "version": 0.1,
        "timestamp": 1722266342583,
        "message": "The field 'from' cannot be empty."
    }
}

400: Bad Request Invalid field options

{
   "message": {
        "version": 0.1,
        "timestamp": 1722266342583,
        "message": "The 'status' field option is not valid."
    }
}

Obtain alerts of the validations

POST https://www.pepdata.com/api/get_alerts

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id_validation	string	id of the validation
ids_validation	string array	Array of the validations ids
status	string	Status of the alerts Default: unresolved Possible values: all resolved unresolved
from	int	Start date of the filter, by the form of milliseconds number from 1st of January 1970 00:00:00 UTC.
until	int	End date of the filter, by the form of milliseconds number from 1st of January 1970 00:00:00 UTC.
page	number	Page of the alerts. Default: 1
include_comments	boolean	Parameter to request information about the comments associated with the alerts. Default: false Possible values: true false

200: OK Validations alerts obtained successfully

{
    "data": {
        "items": [
            {
                "id": "53fef9d4-e3d4-ed03-5e79-38ba066050f7",
                "id_validation": "3462600c-8b9a-6384-c321-4587104ce0f1",
                "name": "José Codinha Manso",
                "birth_date": null,
                "id_country_nationality": "JP",
                "added_at": 1687873995707,
                "resolved_at": null,
                "resolved_by": null,
                "status": "unresolved",
                "reason": "Podem ter sido encontradas novas adverse media relativas a esta pessoa.",
                "country_nationality": "Japan",
                "comments": [
                    {
                        "id": "ff959c5f-8dbb-130c-f904-b0b02359d113",
                        "comment": "Comment 1"
                    },
                    {
                        "id": "2b0c4c70-6730-9056-b3c2-bb8dc21125d3",
                        "comment": "Comment 2"
                    }
                ]
            }
        ],
        "count": 1,
        "total": 1,
        "page": 1,
        "max_results_per_page": 50
    }
    "version": "0.1",
    "timestamp": 1588599744111
}

400: Bad Request Invalid alert status

{
    "message": {
        "version": 0.1,
        "timestamp": 1588599744111,
        "message": "The field 'status' is not valid."
    }
}

Label

• id: id of the alert.

• id_validation: id of the validation.

• name: name of the identifiable person.

• birth_date: birth date of the identifiable person.

• id_country_nationality: code of the nationality country in the format ISO 3166-1 alpha-2.

• added_at: date when the alert was generated, by the form of milliseconds number from 1st of January 1970 00:00:00 UTC.

• resolved_at: date when the alert was resolved, by the form of milliseconds number from 1st of January 1970 00:00:00 UTC.

• resolved_by: user that resolved the alert.

• status: status of the alert.

• reason: reason for creating the alert.

• country_nationality: country of nationality.

• comments: comments associated with the alert.

  • id: id of the comment.

  • comment: comment.

Add validation

POST https://www.pepdata.com/api/add_validation

Endpoint to add a validation.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
ignore_duplicates	boolean	Instruction to ignore the verification of duplicates. Format: 0/1 Default: 0
name*	string	Name of the validation
birth_date	string	Birth date of the validation. Format: yyyy-mm-dd Default: null
country_nationality	string	Country of nationality of the validation. Parameter used only in individual validations. Format: Name of the country (see note bellow) Default: null
id_custom	string	Custom Id of the validation. Default: null
country_residence	string	Country of residence of the validation. Parameter used only in person validations. Format: Name of the country (see note bellow) Default: null
vatin	string	Vat number of the validation Default: null
type	string	Type of entity, that could be: "individual" or "organization" Default: "individual"
country	string	Country of the validation. Parameter used only in organizations validations. Format: Name of the country (see note bellow) Default: null

200: OK Validation successfully added.

{
    "data": {
        "id": "926b7dab-a3af-986f-2137-872adb95260f"
    },
    "version": "0.1",
    "timestamp": 1588599744111
}

409: Conflict The validation to be added is already in the database.

{
    "message": "This validation appears to already exist in the database",
    "version": 0.1,
    "timestamp": 1696943296957
}

400: Bad Request Invalid name

{
    "message": {
        "version": 0.1,
        "timestamp": 1697017288510,
        "message": "Name is invalid. Please provide a name:  • With only Latin characters, apostrophes, spaces, dots or hyphens;"
    }
}

Label

• id: id od the created validation.

country_nationality, country_residence and country

There are multiple different ways to write the name of each country. The PEPData application can identify all the names of countries present in the Lista dos Estados, territórios e moedas da União Europeia. However, in order to ensure greater robustness, we recommend using the ISO 3166-1 alpha-2 format whenever possible.

Analyze validation

POST https://www.pepdata.com/api/analyze_validation

Endpoint to consult the results obtained from the analysis of a validation.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id	string	Id of the validation
include_iperson_details	boolean	Include information about the classifications, occupations and relationships of the identifiable persons. Format: true/false Default: false

200: OK Validation analysis results obtained successfully.

{
    "data": {
        "items": [
            {
              "id": "0bdeb685-8d0b-41ec-a3ff-996188fe2b22",
              "name": "João Pedro Silva",
              "birth_date": null,
              "score": 95
              "classifications": [
                    "PEP"
                ],
                "occupations": [
                    {
                        "organization": "Governo da República Portuguesa",
                        "organ": "Ministério dos Negócios Estrangeiros",
                        "position": "Ministro",
                        "source": "https://test-link.com",
                        "start_date": null,
                        "end_date": null,
                        "comments": null
                    }
                ],
                "relationships": []
            },
            {
              "id": "BFFD688C-4618-048D-9C14-8887B1BDA173",
              "name": "John Frederik White",
              "birth_date": "1933-05-25",
              "score": 76,
              "classifications": [
                    "PEP",
                    "Family Member"
                ],
                "occupations": [
                    {
                        "organization": "Government of the United Kingdom",
                        "organ": "Ministry of Justice",
                        "position": "Minister",
                        "source": "https://test-link.com",
                        "start_date": "2005-01-01",
                        "end_date": "2030-01-01",
                        "comments": null
                    }
                ],
                "relationships": [
                    {
                        "relationship_type": "son",
                        "relationship_to": "Harry Charles White",
                        "source": "https://test-link.com",
                        "end_date": null,
                        "comments": null
                    },
                    {
                        "relationship_type": "spouse",
                        "relationship_to": "Jane Anne White",
                        "source": "https://test-link.com",
                        "end_date": null,
                        "comments": null
                    }
                ]
            }
        ],
        "count": 2
    },
    "version": "0.1",
    "timestamp": 1588599744111
}

400: Bad Request Validation not found

{
    "message": {
        "version": 0.1,
        "timestamp": 1697017640884,
        "message": "The validation was not found"
    }
}

Label

• id: id of the identifiable person.

• name: name of the identifiable person.

• birth_date: date of birth of the identifiable person.

• score: degree of similarity.

• classifications: classifications of the identifiable person.

• occupations: list of occupations of the identifiable person:

  • organization: occupation organization .

  • organ: occupation organ.

  • position: position in occupation.

  • source: source link that relates the identifiable person to the occupation.

  • start_date: occupation start date.

  • end_date: occupation end date.

  • comments: relevant notes about the occupation.

• relationships: list of relationships of the identifiable person.

  • relationship_type: type of relationship.

  • relationship_to: name of the identifiable person's family member.

  • source: source link with information about the relationship.

  • end_date: end date of the relationship.

  • comments: relevant notes about the relationship.

Validation determination

POST https://www.pepdata.com/api/determine_validation

Endpoint to determine a validation.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id	string	Id of the validation
id_entity	string	Id of the corresponding identifiable person or organization.

200: OK The validation was successfully determined.

{
    "version": 0.1,
    "timestamp": 1695805850051,
    "data": {
        "message": "The validation was successfully determined."
    }
}

400: Bad Request Validation not found

{
    "message": {
        "version": 0.1,
        "timestamp": 1697017640884,
        "message": "The validation was not found"
    }
}

Delete validation

POST https://www.pepdata.com/api/delete_validation

Endpoint to delete a validation.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id	string	Id of the validation

200: OK The validation was successfully deleted.

{
    "version": 0.1,
    "timestamp": 1695806667520,
    "data": {
        "message": "The validation was successfully deleted."
    }
}

400: Bad Request Validation not found

{
    "message": {
        "version": 0.1,
        "timestamp": 1697017640884,
        "message": "The validation was not found"
    }
}

Apply rules

POST https://www.pepdata.com/api/apply_rules

Endpoint for applying validation rules.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

200: OK The rules have began to be applied.

{
    "version": 0.1,
    "timestamp": 1695983552463,
    "data": {
        "time_to_conclusion": 1
    }
}

400: Bad Request The rules are already being applied.

{
    "message": {
        "version": 0.1,
        "timestamp": 1695984451235,
        "message": "This operation is already in progress. Please wait until it is complete."
    }
}

200: OK There are no validations eligible to apply the rules.

{
    "version": 0.1,
    "timestamp": 1695983552463,
    "data": {
        "message": "There are no validations eligible to apply the rules."
    }
}

Label

• time_to_conclusion: estimated time in seconds for the operation to complete.

Applying rules may take a few minutes to complete, depending on the number of incomplete validations that exist.

Obtain comments

POST https://www.pepdata.com/api/get_comments

Endpoint to obtain comments.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
page	number	Page of the comments. Default: 1
type	string	Type of the comments. Possible values: determination alert judicial_process adverse_media
id_validation	string	Id of the validation associated with the comments.

200: OK Comments successfully obtained.

{
    "version": 0.1,
    "timestamp": 1697728294225,
    "data": {
        "count": 2,
        "total": 2,
        "items": [
            {
                "id": "ff959c5f-8dbb-130c-f904-b0b02359d113",
                "comment": "Comentário 1",
                "added_at": 1697704218743,
                "added_by": "António Jesus",
                "id_validation": "a086cf5f-99ad-12d6-7a80-3d9a47a638d0",
                "id_iperson": null,
                "id_validation_alert": "e9b629b3-0566-c119-1de3-a86d8436205d",
                "id_validation_judicial_process": null,
                "id_validation_adverse_media": null,
                "id_added_by": "cd9f4a64-ab25-4efb-bf31-323ee2280095"
            },
            {
                "id": "12cdbdba-685d-73d5-fc35-017ecb17c166",
                "comment": "Comentário 2",
                "added_at": 1697704304926,
                "added_by": "António Jesus",
                "id_validation": "6f95d22f-9751-3d02-0784-0c6288c79c66",
                "id_iperson": "91a1d1c0-bfd0-6e4b-3574-08c40bc9e577",
                "id_validation_alert": null,
                "id_validation_judicial_process": null,
                "id_validation_adverse_media": null,
                "id_added_by": "cd9f4a64-ab25-4efb-bf31-323ee2280095"
            }
        ],
        "page": 1,
        "max_results_per_page": 50
    }
}

400: Bad Request Invalid type of comment

{
    "message": {
        "version": 0.1,
        "timestamp": 1697728633346,
        "message": "The comment type is not valid."
    }
}

Label

• id: id of the comment.

• comment: comment.

• added_at: date when the comment was added, by the form of milliseconds number from 1st of January 1970 00:00:00 UTC.

• added_by: user responsible for adding the comment.

• id_validation: id of the validation associated with the comment.

• id_iperson: id of the corresponding identifiable person, if the type of the comment is "determination".

• id_validation_alert: id of the correspondig validation alert, if the type of the comment is "alert".

• id_validation_judicial_process: id of the corresponding judicial process, if the type of the comment is "judicial_process".

• id_validation_adverse_media: id of the corresponding adverse media, if the type of the comment is "adverse_media".

• id_added_by: id of the user responsible for adding the comment.

Add a comment

POST https://www.pepdata.com/api/add_comment

Endpoint for adding a comment

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id_validation*	string	Id of the validation
id_iperson	string	Id of the corresponding identifiable person. This parameter is mandatory if the comment to be added refers to the identification of a validation.
comment*	string	Comment
id_validation_alert	string	Id of the corresponding validation alert. This parameter is mandatory if the comment to be added refers to a validation alert.
id_validation_judicial_process	string	Id of the corresponding judicial process. This parameter is mandatory if the comment to be added refers to a judicial process.
id_validation_adverse_media	string	Id of the corresponding adverse news. This parameter is mandatory if the comment to be added refers to adverse news.

200: OK Comment successfully added.

{
    "version": 0.1,
    "timestamp": 1697730099564,
    "data": {
        "id": "ac33a772-a869-1c36-8569-5cba9cd0542d"
    }
}

400: Bad Request Validation not found.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697730211531,
        "message": "The validation was not found."
    }
}

Label

• id: id of the new comment.

Edit a comment

POST https://www.pepdata.com/api/edit_comment

Endpoint to edit a comment.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id of the comment to be edited
comment*	string	Comment

200: OK Comment successfully edited.

{
    "version": 0.1,
    "timestamp": 1697730574961,
    "data": {
        "message": "Comment successfully edited."
    }
}

400: Bad Request Invalid comment id.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697730622187,
        "message": "The comment was not found."
    }
}

Delete a comment

POST https://www.pepdata.com/api/delete_comment

Endpoint to delete a comment.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id of the comment to be deleted

200: OK Comment successfully deleted.

{
    "version": 0.1,
    "timestamp": 1697730574961,
    "data": {
        "message": "Comment successfully deleted."
    }
}

400: Bad Request Invalid comment id

{
    "message": {
        "version": 0.1,
        "timestamp": 1697730622187,
        "message": "The comment was not found."
    }
}

Obtain relationships of a certain validation

POST https://www.pepdata.com/api/get_validation_relationships

Endpoint to obtain relationships of a certain validation.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id_validation*	string	Id of the validation
page	number	Page of the relationships. Default: 1

200: OK Relationships successfully obtained.

{
    "version": 0.1,
    "timestamp": 1697795044035,
    "data": {
        "items": [
            {
                "id": "7f0c97de-6c71-1461-4d9b-da65b4670824",
                "id_relationship": "a86a80bf-0d90-cdfe-1869-726b898cc426",
                "relationship_type": "representative",
                "relationship_to": "António João Soares",
                "id_relationship_to": "df3250ff-382f-c9aa-346e-ef76dd3d333f",
                "id_relationship_from": "6474d5fc-205a-f750-2dd6-24c5d87a5ee5",
                "added_by": "Carlos Araujo",
                "added_at": 1697795029624
            },
            {
                "id": "3b402dbb-ccef-c773-7fac-3225ce7f0e25",
                "id_relationship": "7c5d3c73-b61c-44ae-6d0a-234e1ea2145b",
                "relationship_type": "manager",
                "relationship_to": "José Manuel Silva",
                "id_relationship_to": "3b981423-e1eb-f30f-b4ff-d72b8f34c43a",
                "id_relationship_from": "6474d5fc-205a-f750-2dd6-24c5d87a5ee5",
                "added_by": "Carlos Araujo",
                "added_at": 1697795038487
            }
        ],
        "count": 2,
        "total": 2,
        "page": 1,
        "max_results_per_page": 50
    }
}

400: Bad Request Validation not found.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697795069776,
        "message": "The validation was not found."
    }
}

Legenda

• id: relationship information table identifier.

• id_relationship: id of the relationship.

• relationship_type: type of the relationship.

• relationship_to: name of the validation for which the relationship was created.

• id_relationship_to: id of the validation for which the relationship was created.

• id_relationship_from: id of the validation from which the relationship was created.

• added_by: user responsible for creating the relationship.

• added_at: date when the relationship was added, by the form of milliseconds number from 1st of January 1970 00:00:00 UTC.

Add a validation relationship.

POST https://www.pepdata.com/api/add_validation_relationship

Endpoint to add a validation relationship.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
organization_vat_number*	string	Vat number of the validation from which the relationship will be created. It must be an organization validation.
vat_number*	string	Vat number of the validation to which the relationship will be created. It must be a person validation if the relationship type is representative, manager or beneficial_owner.
position_in_organization*	string	Type of the relationship. Possible values: representative manager owner beneficial_owner

200: OK Relationship successfully added.

{
    "version": 0.1,
    "timestamp": 1697798272664,
    "data": {
        "id": "8e6c7899-7c13-33d1-0538-50faf20f123e"
    }
}

400: Bad Request Invalid relationship type.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697798319930,
        "message": "The relationship type is not valid."
    }
}

Legenda

• id: id of the new relationship.

Edit a validation relationship

POST https://www.pepdata.com/api/edit_validation_relationship

Endpoint to edit a validation relationship

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id_relationship_info*	string	Relationship information table identifier associated with the relationship to be edited.
position_in_organization*	string	Tipo of relationship. Possible values: representative manager owner beneficial_owner

200: OK Relationship successfully edited.

{
    "version": 0.1,
    "timestamp": 1697798682365,
    "data": {
        "message": "Relationship successfully edited."
    }
}

400: Bad Request Invalid relationship type.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697798319930,
        "message": "The relationship type is not valid."
    }
}

Delete a validation relationship

POST https://www.pepdata.com/api/delete_validation_relationship

Endpoint to delete a validation relationship.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id_relationship_info*	string	Relationship information table identifier associated with the relationship to be deleted.

200: OK Relationship successfully deleted.

{
    "version": 0.1,
    "timestamp": 1697798682365,
    "data": {
        "message": "Relationship successfully deleted."
    }
}

400: Bad Request Invalid relationship information table identifier.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697798319930,
        "message": "The relationship information table identifier is not valid."
    }
}