API

Everything you need to implement our REST API
https://api.appconsent.io/v1/consents?key=:key_id&build_id=:build_id
This endpoint allows you to get consent status for a given ID.
Request
Response
Request
Path Parameters
v1
required
string
Current version of the API
Headers
Authentication
required
string
Authentication token to track down who is asking consent signals.
Query Parameters
key
optional
string
AppConsentID or MAID (GAAID .. IDFA )
build_id
optional
number
Specific build_id in order to get the consent for the right device.
Response
200: OK
Consent successfully retrieved.
{"status":200,"users":[{"consent_string":"BOyukthOyuktiACABAFRC6-AAAAtl7_______9______9uz_Ov_v_f__33e8__9v_l_7_-___u_-33d4u_1vf99yfm1-7etr3tp_87ues2_Xur__79__3z3_9pxP78k89r7337Ew_v-_v-b7BCON_Iw","collect_at":"2020-05-01T15:05:33.284Z"}]}
204: No Content
Could not find a consent for this ID.
{"status":204,"message":"No consent found."}

get
Get Extra-Purposes for a given account

https://api.appconsent.io /v1/extrapurpose?account=:account_id
Get all the extrapurposes availables for a given account.
Request
Response
Request
Path Parameters
v1
required
string
current version of the API
Headers
Authentication
required
string
Authentification Token
Query Parameters
account_id
optional
integer
your account_id
Response
200: OK
{
"result": [
{
"id": 85,
"shortID": "Swo9z3ff",
"AccountID": 22,
"name": "",
"description": null,
"slug": "test-EN",
"replacedByID": null,
"salt": "99f9493f472aa7a3-1594046617562-purpose",
"createdAt": "2020-07-06T14:43:37.000Z",
"updatedAt": "2020-07-06T14:43:37.000Z",
"purposeText": [
{
"id": 1128,
"purposeID": 85,
"lcode": "fr",
"name": "test",
"description": "test",
"archived": 0,
"createdAt": "2020-07-06T14:43:37.000Z",
"updatedAt": "2020-07-06T14:43:37.000Z"
},
{
"id": 1129,
"purposeID": 85,
"lcode": "en",
"name": "test EN",
"description": "test EN",
"archived": 0,
"createdAt": "2020-07-06T14:43:37.000Z",
"updatedAt": "2020-07-06T14:43:37.000Z"
},
{
"id": 1130,
"purposeID": 85,
"lcode": "it",
"name": "test",
"description": "test IT",
"archived": 0,
"createdAt": "2020-07-06T14:43:37.000Z",
"updatedAt": "2020-07-06T14:43:37.000Z"
},
{
"id": 1131,
"purposeID": 85,
"lcode": "es",
"name": "test",
"description": "test ES",
"archived": 0,
"createdAt": "2020-07-06T14:43:37.000Z",
"updatedAt": "2020-07-06T14:43:37.000Z"
},
{
"id": 1132,
"purposeID": 85,
"lcode": "nl",
"name": "test",
"description": "test NL",
"archived": 0,
"createdAt": "2020-07-06T14:43:37.000Z",
"updatedAt": "2020-07-06T14:43:37.000Z"
},
{
"id": 1133,
"purposeID": 85,
"lcode": "pt",
"name": "test",
"description": "test PT",
"archived": 0,
"createdAt": "2020-07-06T14:43:37.000Z",
"updatedAt": "2020-07-06T14:43:37.000Z"
},
{
"id": 1134,
"purposeID": 85,
"lcode": "pl",
"name": "test",
"description": "test PL",
"archived": 0,
"createdAt": "2020-07-06T14:43:37.000Z",
"updatedAt": "2020-07-06T14:43:37.000Z"
},
{
"id": 1135,
"purposeID": 85,
"lcode": "de",
"name": "test",
"description": "test DE",
"archived": 0,
"createdAt": "2020-07-06T14:43:37.000Z",
"updatedAt": "2020-07-06T14:43:37.000Z"
}
]
}
]
}

get
get notices for a given account

https://api.appconsent.io/v1/notices?account=:account_id
Request
Response
Request
Path Parameters
v1
optional
string
current version of the API
Headers
Authentication
required
string
Authentication token to track down who is asking consent signals.
Query Parameters
account_id
required
integer
your account id
Response
200: OK
{
"result": [
{
"noticeID": 808,
"AccountID": 22,
"sourceID": 602,
"versionID": "gZXQKMcex",
"parentVersionID": null,
"experimentID": null,
"layoutID": 1,
"weight": null,
"status": "available",
"pubvendorsFallback": false,
"autoLoad": true,
"default": true,
"createdAt": "2020-07-06T14:49:59.000Z",
"updatedAt": "2020-07-06T14:49:59.000Z",
"desc": null,
"hashFiles": "023c92f2c37b4c938ebc16028071a127::0852f7b1c268a4dbe334b42551376d0d",
"appKey": "01793d1e-485d-4b5e-8684-061e37361ea4",
"source": {
"SourceID": 602,
"iabGvlTwo": 1,
"TargetURL": null,
"bundleId": "com.test.test"
},
"build": [
{
"buildID": 704,
"noticeID": 808,
"vendorList": "na"
}
],
"layout": {
"layoutID": 1,
"hash": "023c92f2c37b4c938ebc16028071a127::0852f7b1c268a4dbe334b42551376d0d"
}
},
{
"noticeID": 807,
"AccountID": 22,
"sourceID": 602,
"versionID": "YUUqeDYjn",
"parentVersionID": null,
"experimentID": null,
"layoutID": 1,
"weight": null,
"status": "available",
"pubvendorsFallback": false,
"autoLoad": true,
"default": true,
"createdAt": "2020-07-06T14:49:38.000Z",
"updatedAt": "2020-07-06T14:49:38.000Z",
"desc": null,
"hashFiles": "023c92f2c37b4c938ebc16028071a127::0852f7b1c268a4dbe334b42551376d0d",
"appKey": "c002f551-68c7-4a62-b012-18a1f24fe76d",
"source": {
"SourceID": 602,
"iabGvlTwo": 1,
"TargetURL": null,
"bundleId": "com.test.test"
},
"build": [
{
"buildID": 703,
"noticeID": 807,
"vendorList": "na"
}
],
"layout": {
"layoutID": 1,
"hash": "023c92f2c37b4c938ebc16028071a127::0852f7b1c268a4dbe334b42551376d0d"
}
}
]
}

get
get sources for a given account.

https://app.appconsent.io/v1/sources?account_id=:account_id
Request
Response
Request
Path Parameters
v1
optional
string
Headers
Authentification
optional
string
Authentification token to track down who is asking for sources descriptions.
Query Parameters
account_id
optional
integer
Your account id
Response
200: OK
{
"result": [
{
"SourceID": 602,
"AccountID": 22,
"type": "App",
"ConsoleUserID": 114,
"iabGvlTwo": 1,
"TargetURL": null,
"bundleId": "com.test.test",
"Scope": "602",
"status": "active",
"firstLogo": null,
"secondLogo": null,
"createdAt": "2020-07-06T14:48:57.000Z",
"updatedAt": "2020-07-06T14:48:57.000Z",
"notes": null
}
]
}