Search Reports

Search for reports by identifier

curl --request POST \
  --url https://api.reporta.ng/api/v1/external/reports/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "identifier": "account",
  "value": "<string>"
}
'

{
  "success": true,
  "message": "<string>",
  "data": {
    "reports": [
      {
        "id": "<string>",
        "companyId": "<string>",
        "userId": "<string>",
        "listingStatus": "<string>",
        "exitedListAt": "<string>",
        "exitListReason": "<string>",
        "fraudType": "<string>",
        "fraudReason": "<string>",
        "showUploaderInfo": true,
        "attachments": [
          "<string>"
        ],
        "status": "published",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "identifiers": [
          {
            "id": "<string>",
            "label": "<string>",
            "value": "<string>"
          }
        ],
        "reportingCompany": {
          "businessName": "<string>",
          "id": "<string>"
        }
      }
    ],
    "publicReports": [
      {
        "id": "<string>",
        "userId": "<string>",
        "fraudReason": "<string>",
        "fraudType": "<string>",
        "attachments": [
          "<string>"
        ],
        "financialInstitution": "<string>",
        "eventDate": "2023-11-07T05:31:56Z",
        "companyId": "<string>",
        "notificationSent": true,
        "status": "published",
        "victim": {},
        "guestInfo": {},
        "reportingEntity": "self",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "identifiers": [
          {
            "id": "<string>",
            "label": "<string>",
            "value": "<string>"
          }
        ]
      }
    ]
  }
}

POST

reports

Search for reports by identifier

curl --request POST \
  --url https://api.reporta.ng/api/v1/external/reports/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "identifier": "account",
  "value": "<string>"
}
'

{
  "success": true,
  "message": "<string>",
  "data": {
    "reports": [
      {
        "id": "<string>",
        "companyId": "<string>",
        "userId": "<string>",
        "listingStatus": "<string>",
        "exitedListAt": "<string>",
        "exitListReason": "<string>",
        "fraudType": "<string>",
        "fraudReason": "<string>",
        "showUploaderInfo": true,
        "attachments": [
          "<string>"
        ],
        "status": "published",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "identifiers": [
          {
            "id": "<string>",
            "label": "<string>",
            "value": "<string>"
          }
        ],
        "reportingCompany": {
          "businessName": "<string>",
          "id": "<string>"
        }
      }
    ],
    "publicReports": [
      {
        "id": "<string>",
        "userId": "<string>",
        "fraudReason": "<string>",
        "fraudType": "<string>",
        "attachments": [
          "<string>"
        ],
        "financialInstitution": "<string>",
        "eventDate": "2023-11-07T05:31:56Z",
        "companyId": "<string>",
        "notificationSent": true,
        "status": "published",
        "victim": {},
        "guestInfo": {},
        "reportingEntity": "self",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "identifiers": [
          {
            "id": "<string>",
            "label": "<string>",
            "value": "<string>"
          }
        ]
      }
    ]
  }
}

Authorizations

x-api-key

string

header

required

Body

application/json

Search criteria

identifier

enum<string>

required

Type of identifier to search

Available options:

account,

bvn,

nin,

drivers_license,

international_passport,

email,

phone,

account_name,

social_handle

value

string

required

Value of the identifier to search for

Response

Reports fetched successfully

success

boolean

required

Indicates if the search was successful

message

string

required

Response message

data

object

required

Show child attributes

data.reports

object[]

required

List of reports matching the search criteria

Show child attributes

data.reports.id

string

Unique ID of the report

data.reports.companyId

string

ID of the company that reported the suspicious activity

data.reports.userId

string | null

ID of the user who reported the suspicious activity

data.reports.listingStatus

string

Status of the report

data.reports.exitedListAt

string | null

Timestamp of when the report was exited from the list

data.reports.exitListReason

string | null

Reason for exiting the list

data.reports.fraudType

string

Type of fraud reported

data.reports.fraudReason

string

Reason for reporting the suspicious activity

data.reports.showUploaderInfo

boolean

Whether to show the uploader information

data.reports.attachments

string[]

List of attachments

data.reports.status

enum<string>

Status of the report

Available options:

published,

draft

data.reports.createdAt

string<date-time>

Timestamp when the report was created

data.reports.updatedAt

string<date-time>

Timestamp when the report was last updated

data.reports.identifiers

object[]

List of encrypted identifiers

Show child attributes

data.reports.identifiers.id

string

required

Unique ID of the identifier

data.reports.identifiers.label

string

required

Identifier label

data.reports.identifiers.value

string

required

Encrypted identifier value

data.reports.reportingCompany

object

Show child attributes

data.reports.reportingCompany.businessName

string

required

Name of the reporting company

data.reports.reportingCompany.id

string

required

ID of the reporting company

data.publicReports

object[]

required

List of public reports matching the search criteria

Show child attributes

data.publicReports.id

string

Unique ID of the report

data.publicReports.userId

string | null

ID of the user who reported the suspicious activity

data.publicReports.fraudReason

string

Reason for reporting the suspicious activity

data.publicReports.fraudType

string

Type of fraud reported

data.publicReports.attachments

string[]

List of attachment URLs

data.publicReports.financialInstitution

string

Name of the financial institution involved

data.publicReports.eventDate

string<date-time>

Date when the fraudulent event occurred

data.publicReports.companyId

string

ID of the company that reported the suspicious activity

data.publicReports.notificationSent

boolean

Whether notification has been sent

data.publicReports.status

enum<string>

Status of the report

Available options:

published,

draft

data.publicReports.victim

object

Information about the victim

data.publicReports.guestInfo

object

Information about the guest reporter

data.publicReports.reportingEntity

enum<string>

Entity that reported the incident

Available options:

self,

witness,

guest,

representative

data.publicReports.createdAt

string<date-time>

Timestamp when the report was created

data.publicReports.updatedAt

string<date-time>

Timestamp when the report was last updated

data.publicReports.identifiers

object[]

List of encrypted identifiers

Show child attributes

data.publicReports.identifiers.id

string

required

Unique ID of the identifier

data.publicReports.identifiers.label

string

required

Identifier label

data.publicReports.identifiers.value

string

required

Encrypted identifier value

Decode Submission Get Bank List

⌘I

Report

Meta Data

File Upload

Authorizations

Body

Response