M2M token request and response properties
This reference describes the properties that SafeSend uses to request and return M2M access tokens.
Token request properties
Property | Required | Type | Description |
|---|---|---|---|
client_id | Yes | String | Application identifier that SafeSend creates for the firm. Obtain this value from the SafeSend Developer section. |
client_secret | Yes | String | Confidential application secret that authenticates the token request. Obtain this value from the SafeSend Developer section. |
audience | Yes | String | Identifier for the target API. Obtain this value from the SafeSend Developer section. |
grant_type | Yes | String | OAuth authentication transfer. Specify client_credentials for M2M authentication. |
Token response properties
Property | Type | Description |
|---|---|---|
access_token | String | Authentication token to include in the Authorization header for SafeSend API calls. |
scope | String | Scope that identifies the permissions granted to the access token. |
expires_in | Integer | The number of seconds that the generated access token remains valid. |
token_type | String | Type of token returned by the authentication service. SafeSend API calls use a Bearer token. |
Error codes for token endpoint
Code | Description | Resolution |
|---|---|---|
200 | The token request succeeded. | Use the returned access token to call SafeSend APIs. |
401 Unauthorized | The request doesn't include valid authentication credentials. | Verify the client_id and client_secret values. |
403 Forbidden | The credentials are valid, but the client can't access the requested resource. | Verify the audience and grant_type values, and verify that the client has permission to access the target API. |
