Relation key

You are here: Home » Resources » How to identify third-parties via headers » For third parties » Relation key

POST method only

Description:

Use this request when you are going to use the shared_provider_id to retrieve the relation_key. To understand the general behaviour of this parameter, please check this. Please, make sure your client has confirmed you can provide data on their behalf. You may read this to understand how to get the confirmation.

You need to provide the shared_provider_id in the body and the user_cert in the headers. The process to retrieve the user_cert is described here.

Environment	Endpoint
Testing	https://test-api.tidisystem.com/relation-key/
Production	https://api.tidisystems.com/relation-key/

Click to open our sandbox on Postman

Input:

Body:

Key	Required	Type	Description
shared_provider_id	True	string	The identifier of the client provided by you on the dashboard and owned by you

Headers:

Key	Required	Type	Description	Obtained by
user_cert	(1)	string	The user certificate retrieve from another endpoint	Check

Output:

1st level JSON	2nd level JSON	Type	Description
relation_key		string	The relation_key necessary to create the third-party certificate
status		string	“OK” if the request was correct; “NOK” otherwise
http_status		int	The HTTP status code
error_trace:	[	list	List of errors' data that occurred during the request
	{	dict
	error_name	string	The error that occurred during the request. You may retrieve more information about it with parameter “errors_url”
	error_message	string	The explanation of the error
	error_code	string	The internal error code, in case you need to contact support to get it fixed.
	}
	]
errors_url		string	The URL to the list of errors, to retrieve more information